Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 2.04 KB

CONTRIBUTING.rst

File metadata and controls

68 lines (45 loc) · 2.04 KB

How to contribute

Reporting bugs

Before reporting please:

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:

  1. Bug description is clear yet concise.
  2. Clear instructions to reliably replicate the issue.
  3. Screenshots rather than descriptions of screens.
  4. Full traceback if one occurred.
  5. 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.

  1. No more than one change per commit. There should be no changes in a commit which are unrelated to its message.
  2. Every Pull Request should pass all tests on its own. Ideally each commit should too.
  3. 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 get help in the Pootle channel.