Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 1.02 KB

Contributing to ng-redux

Developing ng-redux

To run the project, simply npm install. Then, run tests via npm run test or build the entire project via npm build.

Commit convention

ng-redux uses standard-version convention which basically looks like this:

typeOfCommit(locationOfChanges): Commit message

Examples:

fix(lib): Fix ng-redux library issue
feat(build): Build system test watch

And so on. The commits are then compiled into the changelog along with each release.

Release process

For any contributors with release rights:

  1. update package.json with new version bump. Refer to semver for versioning guidelines
  2. run npm prepublish to prepare the new version (the command will create new build files)
  3. commit package.json and build files
  4. tag commit with newest version
  5. push changes to Github
  6. run npm publish to publish the new version to npmjs.com
  7. use Github UI to create a new release