Skip to content

CONTRIBUTING.md

Latest commit

聽

History

History
33 lines (24 loc) 路 1.37 KB

CONTRIBUTING.md

File metadata and controls

33 lines (24 loc) 路 1.37 KB
Raw

Contributing

馃憤馃帀 First off, thanks for taking the time to contribute! 馃帀馃憤

Submitting a Bug Report

When creating the bug report, please follow the bug template and provide details about package version you're using.

Creating a Pull Request

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]

Running Quality Checks

Before you create a pull request, please make sure your changes fulfill the quality criteria:

  1. Install the dependencies with composer install in the project root
  2. Run PHP-CS-Fixer v3 (not provided with the library, has to be installed locally): php-cs-fixer fix
  3. Run the unit tests with vendor/bin/phpunit
  4. Run PHP CodeSniffer with vendor/bin/phpcs --standard=php_cs.xml app src tests
  5. Run Psalm with vendor/bin/psalm and address any error-level issues