CONTRIBUTING.md

Contributing

Code of Conduct

Before contributing to this project, please read our code of conduct.

CI/CD Pipelines

We are using GitHub Actions as a continuous integration system.

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

• workflows/lint.yaml
• workflows/static-code-analysis.yaml
• workflows/test.yaml

Coding Standards

We are using ergebnis/composer-normalize to normalize composer.json.

We are using yamllint to enforce coding standards in YAML files.

We are using sclable/xml-lint to enforce coding standards in XML files.

We are using symplify/easy-coding-standard and rector/rector to enforce coding standards in PHP files and Markdown code snippets.

Run

make cs

to automatically fix coding standard violations.

Static Code Analysis

We are using maglnet/composer-require-checker to prevent the use of unknown symbols in production code.

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

Run

make analysis

to run a static code analysis.

Tests

We are using phpunit/phpunit to drive the development.

We are using infection/infection and roave/no-leaks to ensure a minimum quality of the tests.

Run

$ make tests

to run all the tests.

Extra lazy?

Run

make check

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

Help

💡 Run

make help

to display a list of available targets with corresponding descriptions.