Skip to content

Commit

Permalink
docs(breaking-change): highlighted the need for BREAKING CHANGE: t…
Browse files Browse the repository at this point in the history
…o be in the commit footer (#2283)

since this is a common confusion point for new folks
  • Loading branch information
travi committed Dec 2, 2021
1 parent b64855f commit 5d78fa4
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -60,7 +60,7 @@ The table below shows which commit message gets you which release type when `sem
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------- |
| `fix(pencil): stop graphite breaking when too much pressure applied` | ~~Patch~~ Fix Release |
| `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release |
| `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release |
| `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release <br /> (Note that the `BREAKING CHANGE: ` token must be in the footer of the commit) |

### Automation with CI

Expand Down

0 comments on commit 5d78fa4

Please sign in to comment.