Skip to content

Commit

Permalink
doc: improve commit message example for releases
Browse files Browse the repository at this point in the history
  • Loading branch information
juanarbol committed May 3, 2022
1 parent 2be5966 commit 803cfef
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions doc/contributing/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -406,6 +406,27 @@ good place to @-mention the relevant contributors.
After opening the PR, update the release commit to include `PR-URL` metadata and
force-push the proposal.

If using the `<details>` tag:

```markdown
<details>
<summary>Commits</summary>

* Full list of commits...
</details>
PR-URL: TDB
```

In case the adopted format is the same as the changelog one:

```markdown
Notable changes:

* Copy the notable changes list here, reformatted for plain-text

PR-URL: TBD
```

### 7. Ensure that the release branch is stable

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

0 comments on commit 803cfef

Please sign in to comment.