👍🎉 First off, thanks for taking the time to contribute! 🎉👍
When creating the bug report, please follow the bug template and provide details about package version you're using.
You're welcome to contribute new features by creating a pull requests or feature request in the issues section.
For pull requests, please follow these guidelines:
- Symfony code style (use
php_cs.xml
to configure the code style in your IDE) - PHP7.1 type hints for everything (including: return types,
void
, nullable types) declare(strict_types=1)
must be used- Please add/update test cases
- Test methods should be named
[method]_[scenario]_[expectedResult]
Before you create a pull request, please make sure your changes fulfill the quality criteria:
- Install the dependencies with
composer install
in the project root - Run PHP-CS-Fixer v3 (not provided with the library, has to be
installed locally):
php-cs-fixer fix
- Run the unit tests with
vendor/bin/phpunit
- Run PHP CodeSniffer with
vendor/bin/phpcs --standard=php_cs.xml src tests
- Run Psalm with
vendor/bin/psalm
and address any error-level issues