LINEIntegration/vendor/linecorp/line-bot-sdk/HACKING.md
2023-08-21 17:41:42 +09:00

1.2 KiB

Hacking guide for SDK developers

Testing

Run make or make check to check comprehensively. Following tests will run.

Pull request policy

  • 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

Release Flow

Install phpDocumenter before releasing new version.

  1. Update VERSION constant varialbe at Constant/Meta.php
  2. Generate HTML phpdoc php phpDocumentor.phar
  3. Make a git tag (this project uses semantic versioning)
  4. Push the tag to origin
  5. Edit GitHub releases

That's all. It will be publish on composer automatically.