simon/semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(readme): add convention links

Browse Source 
Link to commitizen and validate-commit-msg for project maintainers to simplify contributing.
This commit is contained in:
Kent C. Dodds 2015-09-15 14:11:30 -06:00 committed by Stephan Bönnemann
parent df5f8337e8
commit 81de8ae19b
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -96,7 +96,7 @@ _Note:_ The current release/tag implementation is tied to GitHub, but could be o
This module ships with the [AngularJS Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit) and changelog generator, but you can [define your own](#plugins) style. This module ships with the [AngularJS Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit) and changelog generator, but you can [define your own](#plugins) style.
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
format that includes a **type**, a **scope** and a **subject**: format that includes a **type**, a **scope** and a **subject** ([full explanation](https://github.com/ajoslin/conventional-changelog/blob/master/conventions/angular.md)):
``` ```
<type>(<scope>): <subject> <type>(<scope>): <subject>
@ -106,7 +106,7 @@ format that includes a **type**, a **scope** and a **subject**:
<footer> <footer>
``` ```
[Full explanation](https://github.com/ajoslin/conventional-changelog/blob/master/conventions/angular.md) You can simplify using this convention for yourself and contributors by using [commitizen](https://github.com/commitizen/cz-cli) and [validate-commit-msg](https://github.com/kentcdodds/validate-commit-msg).
## Setup ## Setup