Skip to content

Latest commit

 

History

History
22 lines (16 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

22 lines (16 loc) · 1.45 KB
Raw

Contributing

First of all thank you for contributing!

Make your contributions through Pull Requests

Find here a few rules to follow in order to keep the code clean and easy to review and merge:

  • Follow PSR-2 coding standard
  • Unit test everything and run the test suite
  • Try not to bring code coverage down
  • Keep documentation updated
  • Just one pull request per feature at a time
  • Check that Travis CI build passed

Composer scripts are provided to help you keep code quality and run the test suite:

  • composer lint will run PHP linting and PHP Code Sniffer and PHP-CS-Fixer for coding style guidelines check
  • composer fix will run PHP-CS-Fixer trying to fix coding styles
  • composer qa will run PHPCPD for copy/paste detection, PHPMD and PHPStan for static analysis
  • composer security will run Composer (>=1.1.0) for outdated dependencies
  • composer test will run PHPUnit for unit tests and Infection for mutation tests