CONTRIBUTING.md

CONTRIBUTING

We are using GitHub Actions as a continuous integration system.

For details, see workflows/continuous-integration.yml.

Code style

We format the code automatically with php-cs-fixer

make fix

Prefer explicit naming and short, focused functions over excessive comments.

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.