Guidelines for Reviewing and Merging PRs

Reviewing a PR

• If it's a simple typo, URL, or grammatical fix, then:
  1. Make sure it's correct.
  2. Check the preview to verify that the page renders correctly and/or the links work.
  3. Add the Docs LGTM label.
• For something more lengthy:
  1. Do an edit pass.
  2. Suggest any changes in a review.
  3. 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:
  1. Add the Needs Tech Review label.
  2. Assign a reviewer based on who is listed as a reviewer in the file or as appropriate from the Tech reviewers list.
  3. If a tech review has been performed but changes have been requested by the reviewer, change the label from Needs Tech Review to Tech Review: Open Issues.
  4. When all tech issues have been addressed and the reviewer(s) give(s) their /lgtm, change the label from Tech Review: Open Issues to Tech LGTM.

NOTE: If you are a member of sig-docs-maintainers, you can ask the PR author to check the "Allow edits from maintainers" checkbox so that you can make changes directly. This can greatly speed up the process if there are just a few simple edits that need to be made before the PR can be approved.

Merging a PR

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.

NOTE: If you see the "This branch is out-of-date with the base branch" warning, it may block the PR from being merged. Repo admins can override this, but if you do not have sufficient privileges, you can ask the PR author to update the branch -- there is an "Update branch" button in the UI that they can click. If you run into any issues, contact @chenopis or @zacharysarah.