Skip to content
This repository has been archived by the owner on May 6, 2020. It is now read-only.

Latest commit

 

History

History
52 lines (37 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 1.49 KB
Raw

Contributing

  1. Fork (https://github.com/suzuki-shunsuke/rterror/fork)
  2. Clone the forked repository
  3. Install npm dependencies
  4. Create a feature branch
  5. Make your change
  6. Test
  7. Commit your change
  8. Rebase your local changes against the master branch
  9. Create a new Pull Request

Requirements

  • yarn, npm: for commit message validation and Change Log generation

We use some node modules to validate commit messages and generate Change Log.

Install node modules by

$ yarn

or

$ npm i

Test

$ npm t

Commit Message Format

The commit message format of this project conforms to the AngularJS Commit Message Format. By conforming its format, we can generate the Change Log and conform the semantic versioning automatically by standard-version. We validate the commit message with git's commit-msg hook using validate-commit-msg and husky.

Release

We generate the Change Log by standard-version. After merge your PR at the master branch, The author (suzuki-shunsuke) will generate the release tag.

$ npm run release
$ git push origin master --follow-tags