Skip to content

Commit 7599bd4

Browse files
authored
docs: clarify release notes verification steps
Clarify instructions for checking release notes completeness and organization.
1 parent 0a434d3 commit 7599bd4

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

etc/notes/releasing.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,9 @@ 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
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
8284
- You may edit the PR body for any quick edits or re-orderings.
8385
- If there are a number of changes, edit the original PRs and post a new `run` comment
8486
1. Merge the release PR

0 commit comments

Comments
 (0)