Skip to content

Commit 4307764

Browse files
committed
docs(CONTRIBUTING): sync with the change of angular/angular.js#12032
1 parent 4422819 commit 4307764

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CONTRIBUTING.md

+6
Original file line numberDiff line numberDiff line change
@@ -157,9 +157,14 @@ format that includes a **type**, a **scope** and a **subject**:
157157
<footer>
158158
```
159159

160+
The **header** is mandatory and the **scope** of the header is optional.
161+
160162
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
161163
to read on GitHub as well as in various git tools.
162164

165+
### Revert
166+
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
167+
163168
### Type
164169
Must be one of the following:
165170

@@ -193,6 +198,7 @@ The body should include the motivation for the change and contrast this with pre
193198
The footer should contain any information about **Breaking Changes** and is also the place to
194199
reference GitHub issues that this commit **Closes**.
195200
201+
**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.
196202
197203
A detailed explanation can be found in this [document][commit-message-format].
198204

0 commit comments

Comments
 (0)