Contributing

Contributing

Local setup

See the Home page for make install and the available make targets. All tooling runs inside a dev Docker container — no local PHP/Composer install required.

Before committing, make sure the full quality gate passes:

make quality

This runs code style checks, PHPStan static analysis, and the PHPUnit suite — the same checks enforced in CI.

Code conventions

• Follow PSR-12 and the existing code style; make cs-fix applies formatting automatically.
• New code goes under the existing src/ categories (Contracts/, Exceptions/, Models/, Utilities/Helpers/) rather than new top-level directories — see Architecture.
• No PHP syntax newer than 7.1 in src/ or tests/ (see Architecture for why). This is checked automatically in CI and locally via git hooks.

Pull requests

• Branch from develop and open pull requests against develop.
• Keep PRs focused and include tests for new behavior.
• A git hook (CaptainHook) runs code style checks on commit; CI re-runs the full quality and compatibility matrix on the PR.