Skip to content

Latest commit

 

History

History
27 lines (16 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

27 lines (16 loc) · 1.18 KB
Raw

Contributing

Contributions are welcome and will be fully credited.

Contributions are accepted via Pull Requests on Github.

Things you could do

If you want to contribute but do not know where to start, this list provides some starting points.

  • Write more documentation.
  • Make the web pages look more beautiful.
  • Set up TravisCI, StyleCI, ScrutinizerCI.
  • Add more tests.

Pull Requests

  • Add tests! - Your patch won't be accepted if it doesn't have tests.

  • Document any change in behaviour - Make sure the readme.md and any other relevant documentation are kept up-to-date.

  • Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.

  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.

  • Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

Happy coding!