Skip to content

Latest commit

 

History

History
25 lines (13 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

25 lines (13 loc) · 1.42 KB
Raw

Contributing

Contributions are welcome and will be fully credited.

We accept contributions via Pull Requests on Github.

Pull Requests

  • PSR-1 + PSR-2 + Symfony + ++ - The easiest way to apply the conventions is to have a look at the PHP CS Fixer.

  • Add tests! - to ensure a high quality code base, your code patch can't be accepted if it doesn't have tests.

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

  • Consider our release cycle - Since we're using semantic versioning (SemVer v2.0.0). Changes to the API must be done with great consideration, and prevented if at all possible.

  • Create dedicated branches - Master is the stable branch, create a new branch for each subject.

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

  • Choose good names for the pull request - Be descriptive in choosing the branch name, for instance, the type of pull request. As examples: feature/my-pull-request-title, hotfix/my-pull-request-title, bugfix/my-pull-request-title, rollback/my-pull-request-title, etc.

  • Be respectful - Be excellent to other contributors.

Happy coding!