Skip to content

Commit 3d52865

Browse files
committed
docs: expand commit message footer description
With this change we expand the commit message footer section to include more information about breaking changes and deprecations messages.
1 parent 411478c commit 3d52865

File tree

2 files changed

+48
-8
lines changed

2 files changed

+48
-8
lines changed

CONTRIBUTING.md

+24-4
Original file line numberDiff line numberDiff line change
@@ -253,12 +253,32 @@ Just as in the **subject**, use the imperative, present tense: "change" not "cha
253253
The body should include the motivation for the change and contrast this with previous behavior.
254254

255255
### Footer
256-
The footer should contain any information about **Breaking Changes** and is also the place to
257-
reference GitHub issues that this commit **Closes**.
256+
The footer can contain information about breaking changes and deprecations. It is also the place to reference GitHub issues, Jira tickets, and other PRs that are related to this commit or that this commit will close.
257+
For example:
258258

259-
**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.
259+
```
260+
BREAKING CHANGE: <breaking change summary>
261+
<BLANK LINE>
262+
<breaking change description + migration instructions>
263+
<BLANK LINE>
264+
<BLANK LINE>
265+
Fixes #<issue number>
266+
```
267+
268+
or
269+
270+
```
271+
DEPRECATED: <what is deprecated>
272+
<BLANK LINE>
273+
<deprecation description + recommended update path>
274+
<BLANK LINE>
275+
<BLANK LINE>
276+
Closes #<pr number>
277+
```
278+
279+
Breaking Change section should start with the phrase "BREAKING CHANGE: " followed by a summary of the breaking change, a blank line, and a detailed description of the breaking change that also includes migration instructions.
260280

261-
A detailed explanation can be found in this [document][commit-message-format].
281+
Similarly, a Deprecation section should start with "DEPRECATED: " followed by a short description of what is deprecated, a blank line, and a detailed description of the deprecation that also mentions the recommended update path.
262282

263283
## <a name="cla"></a> Signing the CLA
264284

scripts/templates/contributing.ejs

+24-4
Original file line numberDiff line numberDiff line change
@@ -246,12 +246,32 @@ Just as in the **subject**, use the imperative, present tense: "change" not "cha
246246
The body should include the motivation for the change and contrast this with previous behavior.
247247

248248
### Footer
249-
The footer should contain any information about **Breaking Changes** and is also the place to
250-
reference GitHub issues that this commit **Closes**.
249+
The footer can contain information about breaking changes and deprecations. It is also the place to reference GitHub issues, Jira tickets, and other PRs that are related to this commit or that this commit will close.
250+
For example:
251251

252-
**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.
252+
```
253+
BREAKING CHANGE: <breaking change summary>
254+
<BLANK LINE>
255+
<breaking change description + migration instructions>
256+
<BLANK LINE>
257+
<BLANK LINE>
258+
Fixes #<issue number>
259+
```
260+
261+
or
262+
263+
```
264+
DEPRECATED: <what is deprecated>
265+
<BLANK LINE>
266+
<deprecation description + recommended update path>
267+
<BLANK LINE>
268+
<BLANK LINE>
269+
Closes #<pr number>
270+
```
271+
272+
Breaking Change section should start with the phrase "BREAKING CHANGE: " followed by a summary of the breaking change, a blank line, and a detailed description of the breaking change that also includes migration instructions.
253273

254-
A detailed explanation can be found in this [document][commit-message-format].
274+
Similarly, a Deprecation section should start with "DEPRECATED: " followed by a short description of what is deprecated, a blank line, and a detailed description of the deprecation that also mentions the recommended update path.
255275

256276
## <a name="cla"></a> Signing the CLA
257277

0 commit comments

Comments
 (0)