Please have in mind that this library is PSR-2 compliant. No changes can be merged that are not PSR-2 compliant.
The code should have a 100% code coverage. To run the code coverage is not necessary - it will run on pull request. If There is something not testable we either find a solution or mark it with @ignoreCodeCoverage.
To run the tests you just have to install the dev dependencies with composer install
. Then you can start both:
Unit tests composer test
and code sniffer composer code-style
.
You should update the documentation according to your changes.
In order to update the API reference you will also have to install docker. Use this command to update the documentation:
$ docker run --rm --user $(id -u) -v $(pwd):/data -v $(pwd)/docs/_reference:/opt/phpdoc/data/templates/_reference iras/phpdoc2:2 phpdoc -c phpdoc.xml