CONTRIBUTING.md

CONTRIBUTING

We are using GitHub Actions as a continuous integration system.

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

• workflows/integrate.yaml
• workflows/merge.yaml
• workflows/release.yaml
• workflows/renew.yaml
• workflows/triage.yaml

Coding Standards

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

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

If you do not have yamllint installed yet, run

brew install yamllint

to install yamllint.

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

Run

make coding-standards

to automatically fix coding standard violations.

Dependency Analysis

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

Run

make dependency-analysis

to run a dependency analysis.

Refactoring

We are using rector/rector to automatically refactor code.

Run

make refactoring

to automatically refactor code.

Security Analysis

We are using composer to run a security analysis.

Run

make security-analysis

to run a security analysis.

Static Code Analysis

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.

Extra lazy?

Run

make

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

Help

💡 Run

make help

to display a list of available targets with corresponding descriptions.