From 567495cebc03da515852cfe6b9426e0b0d4d2c3a Mon Sep 17 00:00:00 2001 From: Dwayne Bailey Date: Sun, 27 Sep 2015 03:26:53 +0100 Subject: [PATCH] Docs: Add CONTRIBUTING guide Fixes #3999. --- CONTRIBUTING.rst | 68 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 00000000000..024b62def11 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,68 @@ +How to contribute +================= + +Reporting bugs +-------------- + +Before reporting please: + +- Double-check `the documentation + `_. +- Make sure `the issue hasn't been already reported + `_. + + +Write your bug report so that you ensure developers are fixing the bug rather +than spending time trying to understand it. If we can't see it or replicate it, +likely we can't fix it. + +Checklist: + +#. Bug description is clear yet concise. +#. Clear instructions to reliably replicate the issue. +#. Screenshots rather than descriptions of screens. +#. Full traceback if one occurred. +#. Links to the actual issue. + + +Commits and Pull Requests +------------------------- + +Before contributing any code, please: + +- Do not write any code without consulting about it first, unless it is a + trivial fix. Someone else can be already working on it. +- Think if any code is needed at all: `The Best Code is No Code At All + `_. + + +Keep the commit log as healthy as the code. It is one of the first places new +contributors will look at the project. + +#. No more than one change per commit. There should be no changes in a commit + which are unrelated to its message. +#. Every Pull Request should pass all tests on its own. Ideally each commit + should too. +#. Follow `these conventions `_ when + writing the commit message. + + +When filing a Pull Request, make sure it is rebased on top of most recent +`master`. If you need to modify it or amend it in some way, you should always +appropriately fixup the issues in git and force-push your changes to your fork. + +Also see: `Github Help: Using Pull Requests +`_ + + +Translations +------------ + +Please `translate online `_. + + +Not sure how to contribute? +--------------------------- + +You can always seek for help in the `#pootle `_ +IRC channel.