-
Notifications
You must be signed in to change notification settings - Fork 14.6k
Guidelines for Reviewing and Merging PRs
Andrew Chen edited this page Aug 17, 2017
·
9 revisions
- If it's a simple typo, URL, or grammatical fix, then:
- Make sure it's correct.
- Check the preview to verify that the page renders correctly and/or the links work.
- Add the label
Docs LGTM
.
- For something more lengthy:
- Do an edit pass.
- Suggest any changes in a review.
- If there are any outstanding issues that need to be resolved, add the
Docs Review: Open Issues
label.
- Anything that you are not sure about the technical correctness of:
- Add the
Needs Tech Review
label. - Assign a reviewer based on who is listed as a
reviewer
in the file or as appropriate from the Tech reviewers list.
- Add the
Once a PR has a Docs LGTM
and, if needed, a Tech LGTM
, you can then merge it or write a comment to @chenopis or @zacharysarah to tell one of them to merge it.
- If there are multiple commits, use "Squash and merge."
- Otherwise, use "Rebase and merge."
- Only use "Merge pull request" if the branch is up-to-date and there is only one commit.