docs: clarify release notes verification steps#4960
Open
dariakp wants to merge 2 commits into
Open
Conversation
Clarify instructions for checking release notes completeness and organization.
dariakp
commented
Jun 9, 2026
dariakp
commented
Jun 9, 2026
dariakp
commented
Jun 9, 2026
dariakp
left a comment
dariakp
left a comment
Contributor
Author
There was a problem hiding this comment.
Additional clarifications
Co-authored-by: Daria Pardue <daria.pardue@mongodb.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Clarifies the release process documentation by expanding the “release notes verification” guidance so maintainers can more consistently validate the generated notes before merging a release PR.
Changes:
- Adds concrete verification checks for generated release notes (completeness and JIRA cross-check).
- Clarifies when it’s acceptable to edit the release PR body directly vs. when to update source PRs and re-run release notes generation.
| - If there are a number of changes, edit the original PRs and post a new `run` comment | ||
| - Double check the result looks logically organized and complete | ||
| - As a rule of thumb, every `feat` and `fix` should have a corresponding release note | ||
| - Cross-reference the list of tickets in the corresponding jira release for consistency |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Summary of Changes
Clarified release instructions around release note verification.
What is the motivation for this change?
Process clarity.
Double check the following
npm run check:lint)type(NODE-xxxx)[!]: descriptionfeat(NODE-1234)!: rewriting everything in coffeescript