Skip to content

Latest commit

 

History

History
23 lines (17 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

23 lines (17 loc) · 1.47 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

Grunt tasks are provided to help you keep code quality and run the test suite:

  • grunt qa will run PHP linting, PHP Code Sniffer for coding style guidelines, PHPMD for code smells and PHPCPD for copy/paste detection
  • grunt test will run PHPUnit for unit tests
  • grunt security will run Composer (>=1.1.0) for outdated dependencies and Security checker for dependencies with known issues
  • grunt serve will run internal PHP server, open a browser window and watch for file changes with Browsersync
  • grunt build building process
  • grunt will run qa and test tasks at once