This file provides information about the project and serves as a guide for those interested in contributing.
The codebase adheres to the SOLID principles. Please keep these principles in mind when introducing new classes or modules to ensure consistency and maintainability.
The project follows the PSR-12 coding standard. Configure your IDE to use
the PHP_CodeSniffer and use the code-quality/phpcs.xml config, or run
the following command to automatically fix style issues:
cd code-quality; composer install; composer phpcbf
The project uses PHPStan for static analysis. Configure your IDE with the
code-quality/phpstan.neon config or run the analysis using the following command:
cd code-quality; composer install; composer phpstan
The tests are powered by Pest. To run the tests:
cd tests; composer install; composer pest
Please open your Pull Requests against the main branch.