Skip to content

Commit 3ba2dd2

Browse files
authored
docs: clarify release notes verification steps (#4960)
1 parent 0a434d3 commit 3ba2dd2

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

etc/notes/releasing.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,11 @@ The MongoDB driver can now generate a cup of joe.
7878
- You may skip this step if you are releasing a package other than the driver.
7979
1. Comment "`run release_notes`" on the release PR.
8080
- This will kick off the action that reads the notes from each PR going into the release.
81-
- Double check the result looks logically organized
82-
- You may edit the PR body for any quick edits or re-orderings.
83-
- If there are a number of changes, edit the original PRs and post a new `run` comment
81+
- Double check the result looks logically organized and complete
82+
- As a rule of thumb, every `feat` and `fix` should have a corresponding release note
83+
- Cross-reference the list of tickets in the corresponding JIRA release for consistency
84+
- You may modify the release PR body directly for any quick edits or re-orderings.
85+
- If there are any non-cosmetic changes, edit the original PRs and post a new `run release_notes` comment
8486
1. Merge the release PR
8587
- If this is a release to a previous major, navigate to the new release and reset "latest" to our latest release in our _current_ major.
8688
1. If this is a new driver minor release, generate the new documentation

0 commit comments

Comments
 (0)