Skip to content

Latest commit

 

History

History
8 lines (8 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

8 lines (8 loc) · 1.44 KB
Raw

How you can contribute to this project:

  • share your ideas by opening issues (either bug reports or feature requests)
  • issue or contribute to a pull request that addresses a specific issue that has been acknowledged
  • PRs should be small, simple, direct and to the point, addressing a specific issue and offering a concrete solution
  • the fix contained in a PR should first be tested locally by the issuer, before being issued against the repo development branch
  • pull requests should generally be made against the development branch, in order to be sure that they can be tested by the community before being pulled into the master branch
  • the master branch should be clean, only tested PRs should be pulled into the master branch (usually passing through the development branch first and then pulled from there). Version releases are created off of the master branch directly.
  • if a PR is more complex and is directed at adding a significant feature, a specific feature branch will first be created, then the PR should be issued against the feature branch, that way the feature can be fully tested by the community before being pulled into the master branch