Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (30 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

38 lines (30 loc) · 2.35 KB

Contributing

Contributions are welcome and will be fully credited.

We accept contributions via Pull Requests on Github.

Pull Requests

  • **PSR-2 Coding Standard ** - Check the code style with $ composer check-style and fix it with $ composer fix-style.
  • Document any change in behavior - 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.

Creating Releases

If you have access to create releases, please note the following:

  • Releases are created automatically when you create a semantically versioned tag (not a release using the GitHub web interface—must be prefixed with v, i.e. v3.1.2)
  • Before creating a tag please ensure the following:
    • CHANGELOG.md has been updated appropriately
    • RELEASE.md has been updated appropriately—the text of this file will be what is added to the release notes created by the .github/workflows/release.yml action. Often this will be the section of the CHANGELOG.md for this release but may include more information relevant to this release
    • README.md has been updated appropriately
    • composer.lock is correct—the GitHub action will use whatever version of dependencies in the lock file
    • config/module.ini is created updated by the GitHub action using the data in UpdateModuleIni.php and the name of the tag. You should keep this up to date but, in case you forget, once you create a tag it will update the config/module.ini with the correct version in the zip file in case you forget before pushing the tag.

Happy coding!