PR wranglers

    This section covers the duties of a PR wrangler. For more information on giving good reviews, see Reviewing changes.

    Each day in a week-long shift as PR Wrangler:

    • Triage and tag incoming issues daily. See for guidelines on how SIG Docs uses metadata.
    • Review open pull requests for quality and adherence to the and Content guides.
      • Start with the smallest PRs () first, and end with the largest (size/XXL). Review as many PRs as you can.
    • Make sure PR contributors sign the .
    • Provide feedback on changes and ask for technical reviews from members of other SIGs.
      • Provide inline suggestions on the PR for the proposed content changes.
      • If you need to verify content, comment on the PR and request more details.
      • Assign relevant sig/ label(s).
      • If needed, assign reviewers from the block in the file’s front matter.
      • You can also tag a SIG for a review by commenting @kubernetes/<sig>-pr-reviews on the PR.
    • Use the /approve comment to approve a PR for merging. Merge the PR when ready.
      • PRs should have a comment from another member before merging.
      • Using style fixups as good first issues is a good way to ensure a supply of easier tasks to help onboard new contributors.

    The following queries are helpful when wrangling. After working through these queries, the remaining list of PRs to review is usually small. These queries exclude localization PRs. All queries are against the main branch except the last one.

    • : Remind the contributor to sign the CLA. If both the bot and a human have reminded them, close the PR and remind them that they can open it after signing the CLA. Do not review PRs whose authors have not signed the CLA!
    • Needs LGTM: Lists PRs that need an LGTM from a member. If the PR needs technical review, loop in one of the reviewers suggested by the bot. If the content needs work, add suggestions and feedback in-line.
    • : Lists PRs that need an /approve comment to merge.
    • Quick Wins: Lists PRs against the main branch with no clear blockers. (change “XS” in the size label as you work through the PRs [XS, S, M, L, XL, XXL]).
    • : If the PR is against a dev- branch, it’s for an upcoming release. Assign the docs release manager using: . If the PR is against an old branch, help the author figure out whether it’s targeted against the best branch.

    Close PRs where:

    • The author hasn’t signed the CLA for two weeks.

      Authors can reopen the PR after signing the CLA. This is a low-risk way to make sure nothing gets merged without a signed CLA.

    Don’t be afraid to close pull requests. Contributors can easily reopen and resume works in progress. Often a closure notice is what spurs an author to resume and finish their contribution.

    To close a pull request, leave a /close comment on the PR.

    Note: The bot marks issues as stale after 90 days of inactivity. After 30 more days it marks issues as rotten and closes them. PR wranglers should close issues after 14-30 days of inactivity.