Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit 0d941a9

Browse files
stevemaopetebacondarwin
authored andcommitted
docs(CONTRIBUTING): how to write a breaking change
Closes #12032
1 parent 8714cab commit 0d941a9

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

CONTRIBUTING.md

+1
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,7 @@ The body should include the motivation for the change and contrast this with pre
235235
The footer should contain any information about **Breaking Changes** and is also the place to
236236
reference GitHub issues that this commit **Closes**.
237237
238+
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
238239
239240
A detailed explanation can be found in this [document][commit-message-format].
240241

0 commit comments

Comments
 (0)