Skip to content

Latest commit

 

History

History
33 lines (28 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

33 lines (28 loc) · 1.84 KB
Raw

For the impatient: report, confirm, claim, fork, branch, write, test, push.

The short version:

  • Make sure the issue you are working on is reported and confirmed, add a note to the issue to claim your intention to work on it.
  • Fork ChiliProject on GitHub
  • Create a new branch from master with a descriptive name prefixed by the issue ID (Example: 123-change_background_from_black_to_blue).
  • Make changes according to our Code Standards.
    1. Be sure to include tests as necessary.
    2. Make sure to not break existing tests.
    3. Please try to make sure your code is going to pass a Code Review prior to submitting the patch. If in doubt, just ask.
  • Either upload your branch to GitHub and send a pull request to the ChiliProject repository, or attach a patch to the issue on ChiliProject. If you send a pull request on GitHub, remember to link to the pull request in the issue you create on ChiliProject and to link to the issue on ChiliProject in the pull request on GitHub.
  • Make sure you watch the corresponding issue in case any discussion arises or improvements are needed.

The long version is on the Contribute Code page.