CONTRIBUTING.md

How to contribute to LINE Bot SDK for PHP project

First of all, thank you so much for taking your time to contribute! LINE Bot SDK for PHP is not very different from any other open source projects you are aware of. It will be amazing if you could help us by doing any of the following:

• File an issue in the issue tracker to report bugs and propose new features and improvements.
• Ask a question using the issue tracker (Please ask only about this SDK).
• Contribute your work by sending a pull request.

Development

Install dependencies

Run composer install to install all dependencies for development.

Understand the project structure

The project structure is as follows:

• src: The main library code.
• test: Test code.
• examples: Example projects that use the library.
• tools: Development tools including code generation scripts.
• generator: Helper project used to fetch the OpenAPI Generator CLI for local code generation.
• docs: Auto-generated Documentation files by phpDocumentor.

Edit OpenAPI templates

Almost all code is generated with OpenAPI Generator based on line-openapi's YAML files. Thus, you cannot edit almost all code under src/clients/ and src/webhook/ directly.

You need to edit the custom templates under tools/custom-template instead.

After editing the templates, run python generate-code.py to generate the code, and then commit all affected files. If not, CI status will fail.

When you update code, be sure to check consistencies between generated code and your changes.

Add unit tests

We use PHPUnit for unit tests. Please add tests to the appropriate test directories to verify your changes.

Especially for bug fixes, please follow this flow for testing and development:

1. Write a test before making changes to the library and confirm that the test fails.
2. Modify the code of the library.
3. Run the test again and confirm that it passes thanks to your changes.

Run your code in your local

You can use the example projects to test your changes locally before submitting a pull request.

Run CI tasks in your local

Run composer check to check comprehensively. Following tests will run.

• PHPUnit composer test
• PHP_CodeSniffer composer cs
• PHPMD composer md
• PHPStan composer stan
• Copyright check composer copyright

Documentation

https://line.github.io/line-bot-sdk-php/

We use phpDocumentor to generate API documentation. Please make sure your new or modified code is covered by proper PHPDoc comments. Good documentation ensures that contributors and users can easily read and understand how the methods and classes work.

Important: You must regenerate and commit the documentation after modifying code in src/ or merging from master. The CI will fail if documentation is out of sync.

To generate documentation locally, run:

$ composer docs

Or manually:

$ wget https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.8.1/phpDocumentor.phar
$ php phpDocumentor.phar run -d src -t docs

Contributor license agreement

When you are sending a pull request and it's a non-trivial change beyond fixing typos, please make sure to sign the ICLA (individual contributor license agreement). Please contact us if you need the CCLA (corporate contributor license agreement).