Skip to content

Latest commit

 

History

History
51 lines (30 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

51 lines (30 loc) · 2.27 KB
Raw

Contributing

Contributions are always welcome 🎉.

We accept contributions through Pull Requests on Github.

Issues

Please create an issue before submitting a Pull Request. This way we can discuss the new feature or problem and come to the best solution before 'wasting time' coding.

Pull Requests

Please follow the following guidelines when creating a pull request:

  • Symfony Coding Standards - See Coding standards and naming conventions for more information.

  • Consider our release cycle - We follow Semantic Versioning 2.0.0. Randomly breaking public APIs is not an option.

  • Create feature branches - Don't ask us to pull from your master branch.

  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.

  • Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

  • Symfony supported versions - An effort is made to always support the currently maintained Symfony versions.

Coding standards and naming conventions

This project follows the Symfony code standards with one exception:

Code style standards are best fixed with the PHP Coding Standards Fixer. Please check your code before creating a commit by running the following command:

make code-style-fix

Running Tests

Run the entire test suite with the following command to see if everything works like it should after your changes:

make test

If you'd like to test your changes against an older Symfony version (eg. 4.4), you can do so by using the following command:

make switch-symfony version=4.4 test