Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: improve commit message example for releases #42954

Merged
merged 1 commit into from
May 6, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/contributing/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,8 @@ YYYY-MM-DD, Version x.y.z (Release Type)
Notable changes:

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

PR-URL: TBD
```

For security releases, begin the commit message with the phrase
Expand All @@ -374,6 +376,8 @@ This is a security release.
Notable changes:

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

PR-URL: TBD
```

### 6. Propose release on GitHub
Expand Down