Skip to content

Latest commit

 

History

History
35 lines (28 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

35 lines (28 loc) · 1.51 KB
Raw

Contributing

If you discover issues, have ideas for improvements or new features, please report them to the issue tracker of the repository or submit a pull request. Please, try to follow these guidelines when you do so.

Issue reporting

  • Check that the issue has not already been reported.

  • Check that the issue has not already been fixed in the latest code (a.k.a. master).

  • Be clear, concise and precise in your description of the problem.

  • Open an issue with a descriptive title and a summary in grammatically correct, complete sentences.

  • Include any relevant code to the issue summary.

Pull requests

  • Read how to properly contribute to open source projects on GitHub.
  • Fork the project.
  • Use a topic/feature branch to easily amend a pull request later, if necessary.
  • Write good commit messages.
  • Use the same coding conventions as the rest of the project.
  • Commit and push until you are happy with your contribution.
  • If your change has a corresponding open GitHub issue, prefix the commit message with [Fix #github-issue-number].
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Open a pull request that relates to only one subject with a clear title and description in grammatically correct, complete sentences.