PR wranglers

SIG Docs approvers take week-long shifts

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

Duties

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

Triage and tag incoming issues daily. See Triage and categorize issues for guidelines on how SIG Docs uses metadata.
Review
Start with the smallest PRs (size/XS) 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 reviewers: block in the file's front matter.

You can also tag a

Use the /approve comment to approve a PR for merging. Merge the PR when ready.

PRs should have a /lgtm comment from another member before merging.

Consider accepting technically accurate content that doesn't meet the style guidelines. As you approve the change, open a new issue to address the style concern. You can usually write these style fix issues as .

Using style fixups as good first issues is a good way to ensure a supply of easier tasks to help onboard new contributors.

Helpful GitHub queries for wranglers

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.

No CLA, not eligible to merge: 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.
Has LGTM, needs docs approval: 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]).
Not against the primary branch: If the PR is against a dev- branch, it's for an upcoming release. Assign the . If the PR is against an old branch, help the author figure out whether it's targeted against the best branch.

Helpful Prow commands for wranglers

# add English label
/language en

# add squash label to PR if more than one commit
/label tide/merge-method-squash

# retitle a PR via Prow (such as a work-in-progress [WIP] or better detail of PR)
/retitle [WIP] <TITLE>

When to close Pull Requests

Reviews and approvals are one tool to keep our PR queue short and current. Another tool is closure.

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.
The author has not responded to comments or feedback in 2 or more weeks.

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

PR Wrangler shadow program

In late 2021, SIG Docs introduced the PR Wrangler Shadow Program. The program was introduced to help new contributors understand the PR wrangling process.

Become a shadow

If you are interested in shadowing as a PR wrangler, please visit the

Kubernetes org members can edit the

Others can reach out on the .

Once you've signed up to shadow a PR Wrangler, introduce yourself to the PR Wrangler on the Kubernetes Slack.

Feedback

Was this page helpful?

Thanks for the feedback. If you have a specific, answerable question about how to use Kubernetes, ask it on Stack Overflow. Open an issue in the GitHub repo if you want to report a problem or suggest an improvement.

Last modified March 07, 2022 at 5:46 PM PST: