Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
executable file
·
29 lines (14 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
29 lines (14 loc) · 1.62 KB
Raw

Contributing

Contributions are welcome and will be fully credited.

We accept contributions via Pull Requests on Github.

Pull Requests

  • PSR-2 Coding Standard - Check the code style with $ composer check-style and fix it with $ composer fix-style.

  • Add tests! - Your patch won't be accepted if it doesn't have tests. $ composer test runs the suite, $ make test runs it inside a container when there is no PHP on your machine.

  • Keep the static analysis green - Run $ composer analyse. PHPStan has to report no errors at all.

  • Keep the coverage up - The code coverage of the test suite has to stay above 94%, which the CI pipeline checks. $ composer test-coverage reports it locally.

  • 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.

  • Create feature branches - Don't ask us to pull from your master branch.

  • 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!