Skip to content

Commit 81ed7c1

Browse files
committed
Revise "review principles" text
This text is great. Jane put this together after talking with the team in some detail in a lang-docs office hours call. In this commit, we revise the wording slightly and adjust capitalization to match our style.
1 parent 38093f5 commit 81ed7c1

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/review-policy.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
Team members are given permission to merge changes from other contributors in the <https://github.com/rust-lang/reference> repository. There are different guidelines for reviewing based on the kind of changes being made:
22

3-
## Review Principles
3+
## Review principles
44

55
Reviewers and authors should focus on a few key principles during the review process:
66

7-
* **Understandability**: Language within the reference should be understandable to most members of the project. Contributions should assumes that readers are familiar with the rest of the content of the reference, but wherever possible sections should facilitate that understanding by linking to related content that are needed to build an understanding.
8-
* **Defensibility**: When the lang-docs team merges a change to the reference they are agreeing to take responsibility for it going forward. Team members need to feel confident defending and explaining the correctness of content within the reference. Whenever possible, changes to the reference should back up any claims they make with concise examples verifying their correctness.
9-
* **Voice**: Authors are not expected to have specification writer competence when drafting new contributions to the reference. So long as claims are understandable and defensible, it is fine for PRs to be written in a casual tone or with the voice of the author instead of the voice of the reference. Team members are expected to bring editorial experience as part of their reviews and will edit the phrasing to fit the reference before merging if necessary.
7+
* **Understandability**: Language within the Reference should be understandable to most members of the Project. Contributions should assumes that readers are familiar with the rest of the content of the Reference, but, wherever possible, sections should facilitate that understanding by linking to related content.
8+
* **Defensibility**: When the lang-docs team merges a change to the Reference, they are agreeing to take responsibility for it going forward. Team members need to feel confident defending and explaining the correctness of content within the Reference. Whenever possible, changes to the Reference should back up any claims with concise examples to verify correctness.
9+
* **Voice**: Authors are not expected to have competence as a specification writer when drafting new contributions to the Reference. So long as claims are understandable and defensible, it is fine for PRs to be written in a casual tone or with the voice of the author instead of the voice of the Reference. Team members will bring editorial experience as part of their reviews and will revise the phrasing, organization, style, etc. to fit the Reference before merging if necessary.
1010

1111
## Policy changes
1212

0 commit comments

Comments
 (0)