Skip to content

Latest commit

 

History

History
49 lines (26 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

49 lines (26 loc) · 1.99 KB

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

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

  • Add tests! - Your patch won't be accepted if it doesn't have tests.

  • Document any change in behaviour - Make sure the README.md and any other relevant documentation are kept up-to-date.

  • 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.

Coding standards and naming conventions

We follow 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:

$ php php-cs-fixer.phar fix src/ --level=symfony
$ php php-cs-fixer.phar fix tests/ --level=symfony

Running Tests

$ vendor/bin/phpunit