CONTRIBUTING

We are using GitHub Actions as a continuous integration system.

For details, take a look at the following workflow configuration files:

Coding Standards

We use ergebnis/composer-normalize to normalize composer.json.

We are using friendsofphp/php-cs-fixer to enforce coding standards in PHP files.

Run

make coding-standards

to automatically fix coding standard violations.

We are using vimeo/psalm to statically analyze the code.

Run

make static-code-analysis

to run a static code analysis.

We are also using the baseline feature of vimeo/psalm.

Run

make static-code-analysis-baseline

to regenerate the baseline in ../psalm-baseline.xml.

❗ Ideally, the baseline should shrink over time.

Run

make

to automatically enforce coding standards and run a static code analysis!

💡 Run

make help

to display a list of available targets with corresponding descriptions.