From b862e28d5bb99d335913afea800ac7d967ef2efa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Doursenaud?= Date: Fri, 23 Jan 2015 14:58:58 +0100 Subject: [PATCH] Added contributing guidelines. See: https://github.com/blog/1184-contributing-guidelines --- CONTRIBUTING.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..f88d1de9a10 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,60 @@ +How to contribute to Dolibarr +============================= + +Bug reports and feature requests +-------------------------------- +Issues are tracked at [Doliforge](https://doliforge.org/projects/dolibarr) + +*You need to create an account before being able to use the "Bugs & Tasks" feature.* + +1. Use the search engine to check if nobody's already reported your problem. +2. Choose the right section. (Bugs or Task and Feature Request). +3. Report with as much detail as possible (Use screenshots or even screencasts whenever possible). + +Code +---- +1. Fork the [GitHub repository](https://github.com/Dolibarr/dolibarr). +2. Clone your fork. +3. Commit and push your changes. +4. Make a pull request. + +### General rules +Please don't edit the ChangeLog file. A project manager will update it from your commit messages. + +### Commits +Use clear commit messages with the following structure: + +
+KEYWORD Short description
+
+Long description (Can span accross multiple lines).
+
+ +Where KEYWORD is one of: + +- void: don't put a keyword if the commit is not introducing feature or closing a bug. +- NEW: for new features (May be followed by the task number i.e: #123) +- FIXED: for bug fixes (May be followed by the bug number i.e: #456) + +### Resources +[Developer documentation](http://wiki.dolibarr.org/index.php/Developer_documentation) + +Translations +------------ +en_US and delta languages (i.e: fr_XX) are maintained in the repository. See Code section above. + +All other translations are managed online at [Transifex](https://www.transifex.com/projects/p/dolibarr). + +Join an existing translation team or create your own and translate into the interface. + +Your translations will be available in the next major release. + +### Resources +[Translator documentation](http://wiki.dolibarr.org/index.php/Developer_documentation) + +Documentation +------------- +The project's documentation is maintained on the [Wiki](http://wiki.dolibarr.org/index.php). + +*You need to create an account before being able to edit.* +