69 lines
5.2 KiB
Markdown
69 lines
5.2 KiB
Markdown
---
|
||
title: PR wranglers
|
||
content_type: concept
|
||
weight: 20
|
||
---
|
||
|
||
<!-- overview -->
|
||
|
||
SIG Docs [approvers](/docs/contribute/participating/roles-and-responsibilites/#approvers) take week-long shifts [managing pull requests](https://github.com/kubernetes/website/wiki/PR-Wranglers) for the repository.
|
||
|
||
This section covers the duties of a PR wrangler. For more information on giving good reviews, see [Reviewing changes](/docs/contribute/review/).
|
||
|
||
<!-- body -->
|
||
|
||
## Duties
|
||
|
||
Each day in a week-long shift as PR Wrangler:
|
||
|
||
- Triage and tag incoming issues daily. See [Triage and categorize issues](/docs/contribute/review/for-approvers/#triage-and-categorize-issues) for guidelines on how SIG Docs uses metadata.
|
||
- Review [open pull requests](https://github.com/kubernetes/website/pulls) for quality and adherence to the [Style](/docs/contribute/style/style-guide/) and [Content](/docs/contribute/style/content-guide/) guides.
|
||
- 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 [CLA](https://github.com/kubernetes/community/blob/master/CLA.md).
|
||
- Use [this](https://github.com/zparnold/k8s-docs-pr-botherer) script to remind contributors that haven’t signed the CLA to do so.
|
||
- 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.
|
||
- 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](/docs/contribute/style/style-guide/). Open a new issue with the label `good first issue` to address style concerns.
|
||
|
||
### 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](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+label%3A%22cncf-cla%3A+no%22+-label%3A%22do-not-merge%2Fwork-in-progress%22+-label%3A%22do-not-merge%2Fhold%22+label%3Alanguage%2Fen):
|
||
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](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+-label%3A%22cncf-cla%3A+no%22+-label%3Ado-not-merge%2Fwork-in-progress+-label%3Ado-not-merge%2Fhold+label%3Alanguage%2Fen+-label%3Algtm):
|
||
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](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+-label%3Ado-not-merge%2Fwork-in-progress+-label%3Ado-not-merge%2Fhold+label%3Alanguage%2Fen+label%3Algtm+):
|
||
Lists PRs that need an `/approve` comment to merge.
|
||
- [Quick Wins](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+base%3Amaster+-label%3A%22do-not-merge%2Fwork-in-progress%22+-label%3A%22do-not-merge%2Fhold%22+label%3A%22cncf-cla%3A+yes%22+label%3A%22size%2FXS%22+label%3A%22language%2Fen%22): 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 main branch](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+label%3Alanguage%2Fen+-base%3Amaster): If the PR is against a `dev-` branch, it's for an upcoming release. Assign the [docs release manager](https://github.com/kubernetes/sig-release/tree/master/release-team#kubernetes-release-team-roles) using: `/assign @<manager's_github-username>`. If the PR is against an old branch, help the author figure out whether it's targeted against the best branch.
|
||
|
||
### 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 [`fejta-bot`](https://github.com/fejta-bot) 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.
|
||
|
||
{{< /note >}} |