Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

25 lines (18 loc) · 1.18 KB
Raw

Contributing

To get started follow these steps:

  1. git clone git@github.com:humanmade/gaussholder.git or fork the repository and clone your fork.
  2. cd gaussholder
  3. npm install
  4. npm run build (to build the assets)

You should then start working on your fork or branch.

Making a pull request

When you make a pull request it will be reviewed. You should also update the CHANGELOG.md - add lines after the title such as - Bug: Fixed a typo #33 to describe each change and link to the issues if applicable.

Making a new release

  1. Create a new branch
  2. Update the version number in the comment header of plugin.php to reflect the nature of the changes, this plugin follows semver versioning.
  • For small changes like bug fixes update the patch version
  • For changes that add functionality without changing existing functionality update the minor version
  • For breaking or highly significant changes update the major version
  1. Add a title heading for the version number above the latest updates in CHANGELOG.md
  2. Create a pull request for the branch
  3. Once merged a release will be built and deployed by CircleCI corresponding to the version number in plugin.php