Thank you for your interest in contributing! Before proceeding, please read the Code of Conduct.
Composer and NPM will both be required to develop & test the library. Once they are configured, run composer install and npm install from the repository root directory to install the required dependencies.
Code is automatically formatted by Prettier. Formatting can be initiated manually with the command composer format. See the Prettier docs to enable file watching & live reformatting.
Static type checking is performed by Psalm. Additional Psalm docblock annotations should be added where necessary to improve type checking. Type analysis & verification can be performed with the command composer analyze.
Unit tests are managed by PHPUnit. Tests can be run with the command composer test.
Before submitting changes, please ensure all code formatting passes validation with the command composer format-check, static analysis passes with the command composer analyze, and all tests pass with the command composer test.
To submit changes, please open a pull request.
Thank you for your contribution!