Skip to content

Commit ed7df68

Browse files
committed
fix(readme): Fix typos in README.md 🐛
1 parent 775dc38 commit ed7df68

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,12 @@ Additionnal options can be set within the plugin definition in `package.json` to
5656
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
5757
| `preset` | [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) preset (possible values: `angular`, `atom`, `codemirror`, `ember`, `eslint`, `express`, `jquery`, `jscs`, `jshint`). | `angular` |
5858
| `config` | NPM package name of a custom [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) preset. | - |
59-
| `releaseRules` | An external module, a path to a module or an `Array` of rules. See [Commit types](#release-rules). | See [Commit types](#release-rules) |
59+
| `releaseRules` | An external module, a path to a module or an `Array` of rules. See [Release rules](#release-rules). | See [Release rules](#release-rules) |
6060
| `parserOpts` | Additional [conventional-commits-parser](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser#conventionalcommitsparseroptions) options that will extends ones loaded by `preset` or `config`. See [Parser options](#parser-options). | - |
6161

6262
**NOTE:** `config` will be overwritten by the values of `preset`. You should use either `preset` or `config`, but not both. Individual properties of `parserOpts` will overwrite ones loaded with `preset` or `config`.
6363

64-
### Commit Types
64+
### Release Rules
6565

6666
#### Rules definition
6767
This is an `Array` of rule objects. A rule object has a `release` property and 1 or more criteria.
@@ -92,7 +92,7 @@ With the previous example:
9292

9393
#### Default rules matching
9494

95-
If a commit doesn't match any rule in `releaseRules` it will be evaluated agaisnt the [default commit types](lib/default/release-rules.js).
95+
If a commit doesn't match any rule in `releaseRules` it will be evaluated agaisnt the [default release rules](lib/default/release-rules.js).
9696

9797
With the previous example:
9898
* Commits with a breaking change will be associated with a `minor` release.
@@ -102,7 +102,7 @@ With the previous example:
102102

103103
#### No rules matching
104104

105-
If a commit doesn't match any rules in `releaseRules` or in [default commit types](lib/default/release-rules.js) then no release type will be associated with the commit.
105+
If a commit doesn't match any rules in `releaseRules` or in [default release rules](lib/default/release-rules.js) then no release type will be associated with the commit.
106106

107107
With the previous example:
108108
* Commits with `type` 'style' will not be associated with a release type.
@@ -140,10 +140,10 @@ For example with `eslint` preset:
140140
With this configuration:
141141
* Commits with `tag` 'Docs', that contains 'README' in their header message will be associated with a `patch` release.
142142
* Commits with `tag` 'New' will be associated with a `patch` release.
143-
* Commits with `tag` 'Breaking' will be associated with a `major` release (per [default commit types](lib/default/release-rules.js)).
144-
* Commits with `tag` 'Fix' will be associated with a `patch` release (per [default commit types](lib/default/release-rules.js)).
145-
* Commits with `tag` 'Update' will be associated with a `minor` release (per [default commit types](lib/default/release-rules.js)).
146-
* Commits with `tag` 'New' will be associated with a `minor` release (per [default commit types](lib/default/release-rules.js)).
143+
* Commits with `tag` 'Breaking' will be associated with a `major` release (per [default release rules](lib/default/release-rules.js)).
144+
* Commits with `tag` 'Fix' will be associated with a `patch` release (per [default release rules](lib/default/release-rules.js)).
145+
* Commits with `tag` 'Update' will be associated with a `minor` release (per [default release rules](lib/default/release-rules.js)).
146+
* Commits with `tag` 'New' will be associated with a `minor` release (per [default release rules](lib/default/release-rules.js)).
147147
* All other commits will not be associated with a release type.
148148

149149
#### External package / file

0 commit comments

Comments
 (0)