From 5d78fa404562d9a3a0bc896c28f89882f7faad9b Mon Sep 17 00:00:00 2001 From: Matt Travi Date: Thu, 2 Dec 2021 12:06:37 -0600 Subject: [PATCH] docs(breaking-change): highlighted the need for `BREAKING CHANGE: ` to be in the commit footer (#2283) since this is a common confusion point for new folks --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e68aab47..06c12385 100644 --- a/README.md +++ b/README.md @@ -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`

`BREAKING CHANGE: The graphiteWidth option has been removed.`
`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release | +| `perf(pencil): remove graphiteWidth option`

`BREAKING CHANGE: The graphiteWidth option has been removed.`
`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release
(Note that the `BREAKING CHANGE: ` token must be in the footer of the commit) | ### Automation with CI