cd /path/to/project
# run all tests
make test
# generate code coverage
make coverage
# show code coverage
make show-coverage
# generate agile documentation
make testdox
# show agile documentation
make show-testdox
or if you don't want to use make, and run with default options:
phpunit
cd /path/to/project
# generate documentation from phpdoc comments with apigen
make doc
Before submitting your changes, make sure to:
- Add the necessary tests.
- Run all the tests to assure nothing else was accidentally broken.
- Add the proper phpdoc comments to your code.
- Check the code coverage and CRAP score.
It is highly recommended to use the git hooks in hooks/ directory to run the test before each commit.
Be sure to follow this convention for your commit messages.