Skip to content

Commit b315904

Browse files
authored
docs: note how to author breaking change commits (#2433)
1 parent f006c40 commit b315904

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

doc/code-submission-guidelines.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,15 @@ Use the imperative, present tense: "change" not "changed" nor "changes", just li
8686

8787
Reference any issue that this commit closes with its fully qualified URL to support both Bitbucket and Github.
8888

89-
If needed, the footer should contain any information about Breaking Changes. Deprecation notices or breaking changes in the Changelog should inform users if they'll need to modify their code after this commit.
89+
If needed, the footer should contain any information about [Breaking Changes](https://www.conventionalcommits.org/en/v1.0.0/). Deprecation notices or breaking changes in the Changelog should inform users if they'll need to modify their code after this commit.
90+
91+
A breaking change should be noted with `BREAKING CHANGE:` (all caps, followed by a colon) and a message.
92+
93+
```
94+
feat(rules): remove deprecated rules
95+
96+
BREAKING CHANGE: remove rules: th-has-headers, checkboxgroup, radiogroup
97+
```
9098

9199
## Submitting a pull request
92100

0 commit comments

Comments
 (0)