Skip to content

Latest commit

 

History

History
33 lines (26 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

33 lines (26 loc) · 1.48 KB
Raw

Contributing

First of all, thanks for thinking about a future contribution to this project.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Github

Code, tests, documentation, wiki and issue tracking are all managed on GitHub so make sure that you have a GitHub account. The Github wiki is available to document the general overview of the application. For more details about issues/PRs consider installing Zenhub.

Bugs

The project's issue tracker is available to report all bugs. Please make sure that you are using the latest version and that you provide a description of how to reproduce the bug.

GitHub Commit Guidelines

  • enhancements and bug fixes should be identified with a GitHub issue
  • commits should be granular enough for other developers to understand the nature/implications of the changes
  • commits shall include a description of changes
  • non-trivial commits shall be associated with an issue ID "#1234" in the Git commit log message
  • for trivial commits that do not need Travis CI to run, include "[ci skip]" as part of the commit message
  • all enhancements or bug fixes must successfully pass all tests before they are committed