Skip to content

Latest commit

 

History

History
12 lines (7 loc) · 1 KB

CONTRIBUTING.md

File metadata and controls

12 lines (7 loc) · 1 KB
Raw

Contributing

  1. Create a branch directly in this repo or a fork (if you don't have push access). Please name branches within this repository <github username>/<description>. For example, something like karmi/install_from_deb.

  2. Create an issue or open a PR. If you aren't sure your PR will solve the issue, or may be controversial, we commend opening an issue separately and linking to it in your PR, so that if the PR is not accepted, the issue will remain and be tracked.

  3. Close (and reference) issues by the closes #XXX or fixes #XXX notation in the commit message. Please use a descriptive, useful commit message that could be used to understand why a particular change was made.

  4. Keep pushing commits to the initial branch, --amend-ing if necessary. Please don't mix fixing unrelated issues in a single branch.

  5. When everything is ready for merge, clean up the branch (rebase with master to synchronize, squash, edit commits, etc) to prepare for it to be merged.