Skip to content

Latest commit

 

History

History
31 lines (25 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

31 lines (25 loc) · 1.3 KB
Raw

Contributing to this repository

Getting started

  • Clone this repository
  • Run npm install

Developing

  • Make your changes
  • Enhance the tests to fail for added rules
  • Check the release notes to see, if there are relevant new features for us to use

Releasing

  • Make sure, you have described your changes in the file CHANGES.md
  • Create a release branch release/x.x.x according to SemVer
  • Move all changes in the file CHANGES.md from below ## Next below a new Paragraph with the to be released version
  • Change the Version in the file package.json
  • Run npm i to update the version in the file package-lock.json
  • Create a Git Tag with the to be released version number git tag 6.5.0
  • Commit and Push the changes to the Release branch (Make sure to also push Tags)
  • Switch to the master branch
  • Merge the release branch into master and push the changes
  • Login to NPM npm login if you not already are logged in
  • Push the Release npm publish
  • Create the Release on the github repo with the changes from the CHANGES.md
  • Merge master back to develop
  • Make sure you have pushed all changes to the Repo