From c7554e7589301ef1728a13a859077509f604dbe3 Mon Sep 17 00:00:00 2001 From: windsonsea Date: Wed, 10 Jan 2024 09:16:47 +0800 Subject: [PATCH] [zh] Sync participate/pr-wranglers.md --- .../contribute/participate/pr-wranglers.md | 119 ++++++++++++------ 1 file changed, 81 insertions(+), 38 deletions(-) diff --git a/content/zh-cn/docs/contribute/participate/pr-wranglers.md b/content/zh-cn/docs/contribute/participate/pr-wranglers.md index 9ec889d8cdaab..09dfd1f4e7487 100644 --- a/content/zh-cn/docs/contribute/participate/pr-wranglers.md +++ b/content/zh-cn/docs/contribute/participate/pr-wranglers.md @@ -11,53 +11,62 @@ weight: 20 -SIG Docs 的[批准人(Approvers)](/zh-cn/docs/contribute/participate/roles-and-responsibilities/#approvers)们每周轮流负责 +SIG Docs 的[批准人(Approver)](/zh-cn/docs/contribute/participate/roles-and-responsibilities/#approvers)们每周轮流负责 [管理仓库的 PR](https://github.com/kubernetes/website/wiki/PR-Wranglers)。 本节介绍 PR 管理者的职责。关于如何提供较好的评审意见, 可参阅[评审变更](/zh-cn/docs/contribute/review/)。 - ## 职责 {#duties} + 在为期一周的轮值期内,PR 管理者要: -- 每天对新增的 Issues 判定和打标签。参见 - [对 Issues 进行判定和分类](/zh-cn/docs/contribute/review/for-approvers/#triage-and-categorize-issues) +- 每天对新增的 Issue 判定和打标签。参见 + [对 Issue 进行判定和分类](/zh-cn/docs/contribute/review/for-approvers/#triage-and-categorize-issues) 以了解 SIG Docs 如何使用元数据的详细信息。 -- 检查[悬决的 PR](https://github.com/kubernetes/website/pulls) 的质量并确保它们符合 - [样式指南](/zh-cn/docs/contribute/style/style-guide/)和 +- 检查[悬决的 PR](https://github.com/kubernetes/website/pulls) + 的质量并确保它们符合[样式指南](/zh-cn/docs/contribute/style/style-guide/)和 [内容指南](/zh-cn/docs/contribute/style/content-guide/)要求。 - 首先查看最小的 PR(`size/XS`),然后逐渐扩展到最大的 PR(`size/XXL`),尽可能多地评审 PR。 -- 确保贡献者完成 [CLA](https://github.com/kubernetes/community/blob/master/CLA.md) 签署。 +- 确保贡献者签署 [CLA](https://github.com/kubernetes/community/blob/master/CLA.md)。 - 使用[此脚本](https://github.com/zparnold/k8s-docs-pr-botherer)自动提醒尚未签署 CLA 的贡献者签署 CLA。 -- 针对提供提供反馈,请求其他 SIG 的成员进行技术审核。 +- 针对变更提供反馈,请求其他 SIG 的成员进行技术审核。 - 为 PR 所建议的内容更改提供就地反馈。 - 如果你需要验证内容,请在 PR 上发表评论并要求贡献者提供更多细节。 - 设置相关的 `sig/` 标签。 @@ -76,8 +85,8 @@ Each day in a week-long shift as PR Wrangler: --> - 使用 `/approve` 评论来批准可以合并的 PR,在 PR 就绪时将其合并。 - PR 在被合并之前,应该有来自其他成员的 `/lgtm` 评论。 - - 可以考虑接受那些技术上准确,但文风上不满足 - [风格指南](/zh-cn/docs/contribute/style/style-guide/)要求的 PR。 + - 可以考虑接受那些技术上准确、 + 但文风上不满足[风格指南](/zh-cn/docs/contribute/style/style-guide/)要求的 PR。 批准变更时,可以登记一个新的 Issue 来解决文档风格问题。 你通常可以将这些风格修复问题标记为 `good first issue`。 - 将风格修复事项标记为 `good first issue` 可以很好地确保向新加入的贡献者分派一些比较简单的任务, @@ -90,9 +99,9 @@ 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. --> -### 对管理者有用的 GitHub 查询 +### 对管理者有用的 GitHub 查询 {#helpful-github-queries-for-wranglers} -执行管理操作时,以下查询很有用。完成以下这些查询后,剩余的要审阅的 PR 列表通常很小。 +执行管理操作时,以下查询很有用。完成以下这些查询后,剩余的要评审的 PR 列表通常很小。 这些查询都不包含本地化的 PR,并仅包含主分支上的 PR(除了最后一个查询)。 - [未签署 CLA,不可合并的 PR](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): - 提醒贡献者签署 CLA。如果机器人和审阅者都已经提醒他们,请关闭 PR,并提醒他们在签署 CLA 后可以重新提交。 + 提醒贡献者签署 CLA。如果机器人和评审者都已经提醒他们,请关闭 PR,并提醒他们在签署 CLA 后可以重新提交。 - **在作者没有签署 CLA 之前,不要审阅他们的 PR!** + **在作者没有签署 CLA 之前,不要评审他们的 PR!** - [需要 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): 列举需要来自成员的 LGTM 评论的 PR。 - 如果需要技术审查,请告知机器人所建议的审阅者。 + 如果需要技术审查,请告知机器人所建议的评审者。 如果 PR 继续改进,就地提供更改建议或反馈。 - [已有 LGTM标签,需要 Docs 团队批准](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+): @@ -132,6 +149,17 @@ These queries exclude localization PRs. All queries are against the main branch ### 对管理者有用的 Prow 命令 {#helpful-prow-commands-for-wranglers} @@ -154,11 +182,13 @@ Reviews and approvals are one tool to keep our PR queue short and current. Anoth 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. + 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. +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. --> @@ -178,10 +208,12 @@ To close a pull request, leave a `/close` comment on the PR. 要关闭 PR,请在 PR 上输入 `/close` 评论。 +{{< note >}} -{{< note >}} 一个名为 [`k8s-ci-robot`](https://github.com/k8s-ci-robot) 的自动服务会在 Issue 停滞 90 天后自动将其标记为过期;然后再等 30 天,如果仍然无人过问,则将其关闭。 PR 管理者应该在 issues 处于无人过问状态 14-30 天后关闭它们。 @@ -190,9 +222,10 @@ PR 管理者应该在 issues 处于无人过问状态 14-30 天后关闭它们 -## PR 管理者影子计划 +## PR 管理者影子计划 {#pr-wrangler-shadow-program} 2021 下半年,SIG Docs 推出了 PR 管理者影子计划(PR Wrangler Shadow Program)。 该计划旨在帮助新的贡献者们了解 PR 管理流程。 @@ -200,23 +233,33 @@ In late 2021, SIG Docs introduced the PR Wrangler Shadow Program. The program wa -### 成为一名影子 +### 成为一名影子 {#become-a-shadow} -- 如果你有兴趣成为一名 PR 管理者的影子,请访问 [PR 管理者维基页面](https://github.com/kubernetes/website/wiki/PR-Wranglers)查看今年的 +- 如果你有兴趣成为一名 PR 管理者的影子,请访问 + [PR 管理者维基页面](https://github.com/kubernetes/website/wiki/PR-Wranglers)查看今年的 PR 管理轮值表,然后注册报名。 -- Kubernetes 组织成员可以编辑 [PR 管理者维基页面](https://github.com/kubernetes/website/wiki/PR-Wranglers), +- Kubernetes 组织成员可以编辑 + [PR 管理者维基页面](https://github.com/kubernetes/website/wiki/PR-Wranglers), 注册成为一名现有 PR 管理者一周内的影子。 -- 其他人可以通过 [#sig-docs Slack 频道](https://kubernetes.slack.com/messages/sig-docs)申请成为指定 +- 其他人可以通过 [#sig-docs Slack 频道](https://kubernetes.slack.com/messages/sig-docs)申请成为指定 PR 管理者某一周的影子。可以随时咨询 (`@bradtopol`) 或某一位 [SIG Docs 联席主席/主管](https://github.com/kubernetes/community/tree/master/sig-docs#leadership)。