First of all, thank you for contributing, you are awesome!
Here are a few rules to follow in order to ease code reviews, and discussions before maintainers accept and merge your work:
- You MUST follow the PSR-1 and PSR-2 recommendations. Use the PHP-CS-Fixer tool to fix the syntax of your code automatically.
- You MUST run the test suite.
- You MUST write (or update) unit tests.
- You SHOULD write documentation.
One may ask you to squash your
too. This is used to "clean" your Pull Request before merging it (we don't want
commits such as
fix 3, etc.).
Also, while creating your Pull Request on GitHub, you MUST write a description which gives the context and/or explains why you are creating it.
Before running the test suite, execute the following Composer command to install the dependencies used by the bundle:
$ composer install --dev
Then, execute the tests executing:
$ npm install google-closure-library
Run the JS test suite with:
$ phantomjs Resources/js/run_jsunit.js Resources/js/router_test.html
$ java -jar plovr.jar build Resources/config/plovr/compile.js
$ php app/console plovr:build @FOSJsRoutingBundle/compile.js