Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (32 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

48 lines (32 loc) · 1.11 KB
Raw

Contributing

After cloning the repository, run composer install to install dependencies.

See https://getcomposer.org/ for Composer installation instructions.

Testing

Running the tests:

composer test

See .travis.yml for PHP versions we currently support.

Generate and view coverage report by running:

composer coverage-html
open ./coverage/report/index.html

To generate clover report run:

composer coverage-clover

Style guide

We follow the PSR-12 Style Guide, which is configured in .phpcs.xml.dist.

Additional checks are configured in .php-cs-fixer.dist.php - See https://cs.symfony.com/ for further information.

Coding style can be verified by running:

composer lint

Note: Windows users that have enabled core.autocrlf in their git configuration can disable the Generic.Files.LineEndings rule by copying .phpcs.xml.dist file to .phpcs.xml and adding an exclusion. This sniff will always be included on Travis CI.