Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

35 lines (22 loc) · 1.28 KB

Thanks for considering contributing to this project! Pull requests are welcome, and if you want to discuss something before starting (or just check if the maintainer is still alive), feel free to open an issue first.

Code style

This project comes with a ruleset.xml file that defines the code style (which is PSR-2 at the time of this writing), so it can be checked with phpcs:

phpcs --standard=ruleset.xml src

The project also comes with an .overcommit.yml file so you can use Overcommit's Git hooks to have your changes checked before each commit.

Tests

Tests are run using PhpUnit:

./vendor/bin/phpunit

If you add new functionality, please consider also adding a test case for it.

Changelog

Consider adding an entry to the CHANGELOG as part of your commit.

Code of conduct

This project adheres to the Open Code of Conduct. By participating, you are expected to honor this code.