Skip to content

Commit 803cfef

Browse files
committed
doc: improve commit message example for releases
1 parent 2be5966 commit 803cfef

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

doc/contributing/releases.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -406,6 +406,27 @@ good place to @-mention the relevant contributors.
406406
After opening the PR, update the release commit to include `PR-URL` metadata and
407407
force-push the proposal.
408408

409+
If using the `<details>` tag:
410+
411+
```markdown
412+
<details>
413+
<summary>Commits</summary>
414+
415+
* Full list of commits...
416+
</details>
417+
PR-URL: TDB
418+
```
419+
420+
In case the adopted format is the same as the changelog one:
421+
422+
```markdown
423+
Notable changes:
424+
425+
* Copy the notable changes list here, reformatted for plain-text
426+
427+
PR-URL: TBD
428+
```
429+
409430
### 7. Ensure that the release branch is stable
410431

411432
Run a **[`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/)**

0 commit comments

Comments
 (0)