Skip to content

Commit bc1396a

Browse files
inf3cti0n95pvdlg
authored andcommitted
docs: clarify breaking change format with default convention
1 parent 30979af commit bc1396a

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,13 @@ The plugin can be configured in the [**semantic-release** configuration file](ht
4444
```
4545

4646
With this example:
47-
- the commits that contains `BREAKING CHANGE` or `BREAKING CHANGES` in their body will be considered breaking changes (by default the [angular preset](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/index.js#L14) checks only for `BREAKING CHANGE`)
47+
- the commits that contains `BREAKING CHANGE` or `BREAKING CHANGES` in their body will be considered breaking changes.
4848
- the commits with a 'docs' `type`, a 'README' `scope` will be associated with a `patch` release
4949
- the commits with a 'refactor' `type` will be associated with a `patch` release
5050
- the commits with a 'style' `type` will be associated with a `patch` release
5151

52+
**Note**: Your commits must be formatted **exactly** as specified by the chosen convention. For example the [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) require the `BREAKING CHANGE` keyword to be followed by a colon (`:`) and to be in the **footer** of the commit message.
53+
5254
## Configuration
5355

5456
### Options

0 commit comments

Comments
 (0)