First of all, thank you for contributing, you are awesome! With your contribution, you not only improve this bundle, but also become part of a great community maintaining it.
Here are a few guidelines to follow in order to ease code reviews, and discussions before maintainers can accept and merge your work. Thank you!
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
Code MUST adhere to all rules outlined in the Symfony Coding Standards as defined by the @Symfony rule set, utilized by the PHP-CS-Fixer tool.
You SHOULD run composer run phpcs-check
to check for any violations. You SHOULD run composer run phpcs-fix
to
fix any potential issues.
You MUST use the static analysis tool PHPStan to analyse any newly added or revised code within this bundle.
You MUST run composer run phpstan
to check for any violations. You MUST fix all violations related to any newly added
or revised code.
You MUST write (or update) unit and/or functional tests for any newly added or revised functionality within this bundle.
You MUST validate newly added or revised tests by running composer run phpunit
.
You SHOULD write (or update) documentation.
You SHOULD write commit messages that make sense.
You MUST rebase your branch before submitting your pull request.
You MUST use a pull request title compliant with the Conventional Commits specification.
You MUST write a meaningful description which gives the context and/or explains why you are creating the pull request.
You SHOULD resolve review comments instead of commenting. Once you've done the work, resolve the conversation by selecting the Resolve conversation button in the PR overview. Avoid posting comments like "I've done the work", or "Done".