Skip to content
This repository has been archived by the owner on Nov 20, 2024. It is now read-only.

Latest commit

 

History

History
46 lines (26 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

46 lines (26 loc) · 1.75 KB

Contributing

Contributions are welcome and will be fully credited.

We accept contributions via Pull Requests on Github.

If you're unsure how to go about forking and all, this guide will help you for sure.

Pull Requests

  • PSR-2 Coding Standard - The easiest way to apply the conventions is to install PHP Code Sniffer.

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

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

Running Tests

$ make sniff test

Automagically fixing against the PSR2 standard

when your code fails against the PSR2 standard, you can automatically fix the errors by using the phpcbf command:

$ vendor/bin/phpcbf src/ --standard=PSR2

Don't forget your test!

$ vendor/bin/phpcbf tests/ --standard=PSR2