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

Commit 423e240

Browse files
committed
docs(CONTRIBUTING): how to write a breaking change
1 parent 1509bc8 commit 423e240

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
@@ -238,6 +238,7 @@ The body should include the motivation for the change and contrast this with pre
238238
The footer should contain any information about **Breaking Changes** and is also the place to
239239
reference GitHub issues that this commit **Closes**.
240240
241+
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or optional two newlines. The rest of the commit message is then used for this.
241242
242243
A detailed explanation can be found in this [document][commit-message-format].
243244

0 commit comments

Comments
 (0)