Run make or make check to check comprehensively. Following tests will run.
- PHPUnit
make test - Copyright check
make copyright - PHP_CodeSniffer
make phpcs - PHPMD
make phpmd - PHPStan
make phpstan
- Please DON'T include the generated HTML phpdoc in pull request
Installing phpDocumenter
We use phpDocumenter to generate API documents automatically. Required packages are not installed by composer because it requires PHP 7.2 ~ 8.0.
$ wget https://phpdoc.org/phpDocumentor.phar
Install phpDocumenter before releasing new version.
- Generate HTML phpdoc
php phpDocumentor.phar - Make a git tag (this project uses semantic versioning)
- Push the tag to origin
- Edit GitHub releases
That's all. It will be publish on composer automatically.