Skip to content

Commit 27bbbbb

Browse files
author
Chris Cho
authored
011924: update review recommendations to improve guidance (#509)
* 011924: update review recommendations to improve guidance
1 parent d78e1aa commit 27bbbbb

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

REVIEWING.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,40 +3,46 @@
33
Contributions to the set of documents in this repository can receive reviews from one or both of the following types of reviews:
44

55
1. A **copy review**, which focuses on information structure and wording; typically performed by a MongoDB Documentation Team member
6-
2. A **technical review**, which addresses code snippets and the technical correctness of prose; typically performed by a MongoDB engineer.
6+
2. A **technical review**, which addresses code snippets and the technical correctness of prose, typically performed by a MongoDB engineer.
7+
8+
# Which Types of Changes for which to Request a Technical Review
9+
10+
- When the PR changes include code snippets.
11+
- When the PR changes include release notes, breaking changes, or upgrading versions.
12+
- To get alignment on specific wording of descriptions of technical information, especially for new features.
13+
- If in doubt, request a technical review.
14+
15+
# What to Review
716

817
See the following sections for reviewer expectations for each type of pull request (PR) review:
918

1019
## Copy Review
1120

12-
Review the structure, wording, and flow of the information in the PR, and correct it if necessary.
21+
A typical copy review consists of the following checks:
1322

14-
### What to Review
15-
16-
- Wording
23+
- Wording, including grammar and spelling
1724
- Page structure
18-
- Technical content to the extent of the reviewers understanding.
25+
- Technical content to the extent of the reviewer's understanding
1926
- Whether the PR fulfills the Acceptance Criteria described in the
20-
linked JIRA ticket.
27+
linked JIRA ticket
2128

2229
### What Not to Review
2330

24-
Nothing is completely off-limits to a copy review of a PR -- if you notice a technical issue, it's best to call it out early.
25-
Copy reviewers should constrain their reviews to content within the scope of the JIRA ticket, or otherwise create PRs to address anything unrelated.
26-
31+
Nothing is entirely off-limits to a copy review of a PR -- if you notice a technical issue, it's best to call it out early.
32+
Copy reviewers should constrain their reviews to content within the scope of the JIRA ticket or otherwise create PRs to address anything unrelated.
2733

2834
## Technical Review
2935

30-
Review the technical accuracy and completeness of a PR and correct it if necessary.
31-
32-
### What to Review
36+
A typical technical review consists of the following checks:
3337

34-
- Code snippets; ensure the code is idiomatic and that all technical claims are correct. e.g. ("To create a `Foo`, use the `Bar.createFoo()` method")
38+
- Technical accuracy
39+
- Release notes, breaking changes, and upgrading pages; ensure the technical claims are correct.
40+
- Code snippets: ensure the code is idiomatic and that all technical claims are correct. e.g. ("To create a `Foo`, use the `Bar.createFoo()` method")
3541
- Problematic explanations that could trip up users who try to follow the documentation.
3642

3743
### What Not to Review
3844

39-
While we welcome any recommendations on wording and structure, avoid blocking approval based on any copy edits. Please entrust the author to make the writing decisions based on style guidelines and team-specific writing conventions, and to create PRs to address anything they deem outside the technical review scope.
45+
While we welcome any recommendations on wording and structure, avoid blocking approval based on any copy edits. Please entrust the author to make the writing decisions based on style guidelines and team-specific writing conventions and to create PRs to address anything they deem outside the technical review scope.
4046

4147
- Wording of sentences, although corrections to technical claims are welcome
4248
- Structure of the page

0 commit comments

Comments
 (0)