diff --git a/docs/review-policy.md b/docs/review-policy.md index 9d61151d2b..2195c4440c 100644 --- a/docs/review-policy.md +++ b/docs/review-policy.md @@ -1,5 +1,13 @@ Team members are given permission to merge changes from other contributors in the repository. There are different guidelines for reviewing based on the kind of changes being made: +## Review principles + +Reviewers and authors should focus on a few key principles during the review process: + +* **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. +* **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. +* **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. + ## Policy changes - Significant changes to the policy of how the team operates, such as changes to this document, should have agreement of the team without any blocking objections.