Skip to content

Files

Latest commit

 

History

History
42 lines (28 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

42 lines (28 loc) · 1.28 KB

Contributing

Contributions are encouraged and welcome; I am always happy to get feedback or pull requests on GitLab.

When contributing there are a few guidelines I would like you to keep in mind:

Pull Requests

  • PSR-12 Coding Standard Please use the following command after you have completed your work:

    composer format

    This will check/correct all the code for the PSR-12 Coding Standard using the wonderful php-cs-fixer.

  • Add unit tests! - Your Pull Request won't be accepted if it does not have tests:

  • Document any change - Make sure the README.md, CHANGELOG.md and any other relevant documentation are kept up-to-date.

  • One pull request per feature - If you want to contribute 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

composer test

,or alternatively run with:

vendor/bin/phpunit