From 4735105d66a9577ff966722cc9293b3540836ea9 Mon Sep 17 00:00:00 2001 From: Francis Gulotta Date: Mon, 9 Oct 2017 15:30:13 -0400 Subject: [PATCH 1/2] fix(readme): Fix spelling errors --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7f6d52ef..522d2def 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Customizable commit-analyzer plugin for [semantic-release](https://github.com/se By default `commit-analyzer` uses the `angular` format described in [Angular convention](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/convention.md). -Additionnal options can be set within the plugin definition in `package.json` to use a different commit format and to customize it: +Additional options can be set within the plugin definition in `package.json` to use a different commit format and to customize it: ```json { @@ -77,7 +77,7 @@ With the previous example: #### Default rules matching -If a commit doesn't match any rule in `releaseRules` it will be evaluated agaisnt the [default release rules](lib/default/release-rules.js). +If a commit doesn't match any rule in `releaseRules` it will be evaluated against the [default release rules](lib/default/release-rules.js). With the previous example: * Commits with a breaking change will be associated with a `minor` release. @@ -96,7 +96,7 @@ With the previous example: #### Multiple commits -If there is multiple commits that match one or more rules, the one with the highest realease type will determine the global release type. +If there is multiple commits that match one or more rules, the one with the highest release type will determine the global release type. Considering the following commits: * `docs(README): Add more details to the API docs` @@ -106,7 +106,7 @@ With the previous example the release type determine by the plugin will be `mino #### Specific commit properties -The properties to set in the rules will depends on the commit style choosen. For example [conventional-changelog-angular](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/index.js#L9-L13) use the commit properties `type`, `scope` and `subject` but [conventional-changelog-eslint](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-eslint/index.js#L9-L12) uses `tag` and `message`. +The properties to set in the rules will depends on the commit style chosen. For example [conventional-changelog-angular](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/index.js#L9-L13) use the commit properties `type`, `scope` and `subject` but [conventional-changelog-eslint](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-eslint/index.js#L9-L12) uses `tag` and `message`. For example with `eslint` preset: ```json From b14939446546bffff7e24b13e9c143b4fea10d97 Mon Sep 17 00:00:00 2001 From: Francis Gulotta Date: Mon, 9 Oct 2017 15:32:44 -0400 Subject: [PATCH 2/2] docs(readme): Add language describing default behavior for rules --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 522d2def..d3754f07 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Customizable commit-analyzer plugin for [semantic-release](https://github.com/se ## Options -By default `commit-analyzer` uses the `angular` format described in [Angular convention](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/convention.md). +By default `commit-analyzer` uses the `angular` format described in [Angular convention](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/convention.md) and the [default rules](lib/default/release-rules.js) for release. Additional options can be set within the plugin definition in `package.json` to use a different commit format and to customize it: @@ -48,6 +48,8 @@ Additional options can be set within the plugin definition in `package.json` to ### Release Rules +Release rules are used when deciding if the commits since the last release warrant a new release. If you define custom release rules the [default rules](lib/default/release-rules.js) will be used if nothing matched. + #### Rules definition This is an `Array` of rule objects. A rule object has a `release` property and 1 or more criteria. ```json