Skip to content

Commit

Permalink
docs(readme): Add language describing default behavior for rules
Browse files Browse the repository at this point in the history
  • Loading branch information
reconbot authored and pvdlg committed Oct 10, 2017
1 parent 98ecfa1 commit d600a6b
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit d600a6b

Please sign in to comment.