CONTRIBUTING.md

CONTRIBUTING

We are using GitHub Actions as a continuous integration system.

For details, see workflows/validate.yml.

Directory structure

Add any source code to publish (classes, config files) in src.

Add tests to tests.

Add files a user of this package would create in their own application in app.

Code Style

We are using friendsofphp/php-cs-fixer to automatically format the code.

Run

make fix

to automatically format the code.

Static Code Analysis

We are using phpstan/phpstan to statically analyze the code.

Run

make stan

to run a static code analysis.

Tests

We are using phpunit/phpunit to drive the development.

Run

make test

to run all the tests.

Extra lazy?

Run

make

to enforce coding standards, perform a static code analysis, and run tests!

💡 Run

make help

to display a list of available targets with corresponding descriptions.