Skip to content

Commit

Permalink
docs(contributing): separate BREAKING CHANGE under its own heading
Browse files Browse the repository at this point in the history
* Explain that is should be formatted as a paragraph.
* Show an example of how to supply it.
  • Loading branch information
myii authored Feb 26, 2019
1 parent 6a4e25a commit ee053d7
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,20 @@ Type|Heading|Description|Bump (default)|Bump (custom)
`style`|Styles|Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)|–|0.0.1
`test`|Tests|Adding missing or correcting existing tests|–|0.0.1

* Adding `BREAKING CHANGE` to the footer of the extended description of the commit message will **always** trigger a `major` version change, no matter which type has been used.
### Use `BREAKING CHANGE` to trigger a `major` version change

Adding `BREAKING CHANGE` to the footer of the extended description of the commit message will **always** trigger a `major` version change, no matter which type has been used.
This will be appended to the changelog and release notes as well.
To preserve good formatting of these notes, the following format is prescribed:

* `BREAKING CHANGE: <explanation in paragraph format>.`

An example of that:

```git
...
BREAKING CHANGE: With the removal of all of the `.sls` files under
`template/package/`, this formula no longer supports the installation of
packages.
```

0 comments on commit ee053d7

Please sign in to comment.