Skip to content

Latest commit

 

History

History
34 lines (16 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

34 lines (16 loc) · 1.6 KB
Raw

Contributing

Contributions are welcome and will be fully credited.

We accept contributions via Pull Requests on Github.

Pull Requests

  • PSR-2 Coding Standard - The easiest way to apply the conventions is to install PHP Code Sniffer.

  • Add tests! - Your new features 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 try to follow SemVer v2.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.

  • Update CHANGELOG.md - If you make relevant changes please add a note to the changelog file with your credits.

  • Update message files - If you make changes to message strings make sure to run vendor/bin/yii message/extract src/User/resources/i18n/config.php in order to update translation files.

Running Tests

See the Running Tests section on the docs.

Happy coding!