Skip to content

Latest commit

 

History

History
27 lines (16 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

27 lines (16 loc) · 1.17 KB

Contributing guide

The contribution is accepted via Pull Requests

Pull Requests

  • Follow the conventions used in the project.

  • 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 - Follow SemVer v2.0.0 specification. 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. Small proposals are reviewed and merged faster than large ones. Use appropriate labels.

  • 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. Please read How to write a good Git commit messages

Running Tests

Run tests to verify your patch does not break existing features.

Enjoy coding!