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 detectiongrunt test
will run PHPUnit for unit testsgrunt security
will run Composer (>=1.1.0) for outdated dependencies and Security checker for dependencies with known issuesgrunt serve
will run internal PHP server, open a browser window and watch for file changes with Browsersyncgrunt build
building processgrunt
will runqa
andtest
tasks at once