011924: update review recommendations to improve guidance #509
Conversation
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
ccho-mongodb
commented
Jan 19, 2024
| @@ -5,32 +5,38 @@ Contributions to the set of documents in this repository can receive reviews fro | |||
| 1. A **copy review**, which focuses on information structure and wording; typically performed by a MongoDB Documentation Team member | |||
| 2. A **technical review**, which addresses code snippets and the technical correctness of prose; typically performed by a MongoDB engineer. | |||
|
|
|||
| # Which Types of Changes for which to Request a Technical Review | |||
There was a problem hiding this comment.
Added this section to make it more clear when to request a technical review.
5 tasks
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.
Pull Request Info
Updated guidance to ensure writers understand that they should get tech reviews for changes that include release notes and breaking changes.
JIRA - None
Staging - None
Self-Review Checklist