Recoil is open source software; contributions from the community are encouraged and appreciated. Please take a moment to read these guidelines before submitting changes.
make
The default target of the make file installs all necessary dependencies and runs the tests.
Code coverage reports can be built with:
make coverage
The coverage reports are written to the artifacts/test/coverage directory.
PHP code must adhere to the PSR-2 as closely as possible. This project includes a php-cs-fixer configuration file to assist with maintaining a consistent style.
Change requests are reviewed and accepted via pull-requests on GitHub. If you're unfamiliar with this process, please read the relevant GitHub documentation regarding forking a repository and using pull-requests.
Before submitting your pull-request (typically against the master branch),
please run:
make prepare
To apply any automated code-style updates, run linting checks, run the tests and build coverage reports. Please ensure that your changes are tested and that a high level of code coverage is maintained.