Skip to content

Commit d913596

Browse files
committed
docs: breaking change
1 parent 9971904 commit d913596

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,17 @@ The commit message must be in the present imperative. This tells someone what th
4444
## Reverter
4545

4646
This type of commit differs between conventional commits and contribution to Angular, however, we chose the example of conventional commits because we understand that the model adopted has greater freedom without compromising simplicity.\
47-
The SHA hash of the commit being rolled back must be reported in Refs.
47+
The SHA hash of the commit being rolled back must be reported in Refs.
48+
49+
50+
## BREAKING CHANGE
51+
52+
```
53+
BREAKING CHANGE: <breaking change summary>
54+
<BLANK LINE>
55+
<breaking change description + migration instructions>
56+
```
57+
58+
All interruption changes must be mentioned as a BREAKING CHANGE block in the footer.\
59+
This block should contain a summary of the last change and a detailed description that also includes migration instructions.\
60+
If BREAKING CHANGE is used, is recommended the use of the exclamation mark "!" in the header as an indicator of significant changes.

0 commit comments

Comments
 (0)