Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

56 lines (41 loc) · 1.86 KB

How to Contribute

Reporting Issues

Before creating a new report, please make sure the issue is not already on file.

Write your report so that you ensure developers are fixing the issue 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.

Common Sense

Before contributing any code, please:

  • Do not write any line of code without consulting about it first, trivial fixes being an exception. Note the project might not be interested in some changes, especially when these are substantial or not in line with the goals and vision.
  • Think if any code is needed at all: The Best Code is No Code At All.

Commits

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.
  • Follow these conventions when writing the commit message.

Pull Requests

We incorporate changes to the mainline master branch by using Pull Requests.

  • When filing a Pull Request, make sure it is rebased on top of the most recent master.
  • Every Pull Request should pass all tests on its own and the build must be passing. Ideally each commit should too.

Also see: Github Help: Using Pull Requests.