From 0f032d6d44af800f451f1b0af67730449579dd78 Mon Sep 17 00:00:00 2001 From: Qiming Teng Date: Sun, 26 Jul 2020 20:37:12 +0800 Subject: [PATCH] [zh] Sync PR wranglers reorg The PR wanglers section was reorganized in 22284. This PR syncs the changes to Chinese localization. --- content/zh/docs/contribute/advanced.md | 126 -------------- .../contribute/participate/pr-wranglers.md | 154 ++++++++++++++++++ .../participate/roles-and-responsibilties.md | 18 +- 3 files changed, 167 insertions(+), 131 deletions(-) create mode 100644 content/zh/docs/contribute/participate/pr-wranglers.md diff --git a/content/zh/docs/contribute/advanced.md b/content/zh/docs/contribute/advanced.md index 771f75b98bf2b..d7a462443826f 100644 --- a/content/zh/docs/contribute/advanced.md +++ b/content/zh/docs/contribute/advanced.md @@ -27,132 +27,6 @@ client and other tools for some of these tasks. - -## 做一周的 PR 管理者 - - -SIG Docs 的[批准人(Approvers)](/zh/docs/contribute/participating/#approvers)们每周轮流负责 -[管理仓库的 PRs](https://github.com/kubernetes/website/wiki/PR-Wranglers)。 - -PR 管理者的工作职责包括: - - -- 每天检查[悬决的 PR](https://github.com/kubernetes/website/pulls) 的质量并确保它们遵守[样式指南](/zh/docs/contribute/style/style-guide/)和[内容指南](/zh/docs/contribute/style/content-guide/)。 - - 首先查看最小的 PR(`size/XS`),然后逐渐扩展到最大的 PR(`size/XXL`)。 - - 尽可能多地审阅 PR。 -- 确保每个贡献者完成 CLA 签署。 - - 指导新的贡献者签署 [CLA](https://github.com/kubernetes/community/blob/master/CLA.md)。 - - 使用[此脚本](https://github.com/zparnold/k8s-docs-pr-botherer)自动提醒尚未签署 CLA 的贡献者签署 CLA。 -- 针对所建议的更改提供反馈,并帮助协调其他 SIG 成员进行技术审核。 - - 为 PR 所建议的内容更改提供在线反馈。 - - 如果您需要验证内容,请在 PR 上发表评论并要求贡献者提供更多细节。 - - 设置相关的 `sig/` 标签。 - - 如果需要,请从文件开头的 `reviewers:` 块中指定审阅者。 - - 设置 `Docs Review` 和 `Tech Review` 标签以标示 PR 的审阅状态。 - - 为尚未审阅的 PR 设置 `Needs Doc Review` 或者 `Needs Tech Review` 标签。 - - 为已审阅的但在合并前需要更多信息的或采取措施的 PR 设置 `Doc Review: Open Issues` 或者 `Tech Review: Open Issues` 标签。 - - 为可以合并的 PR 添加 `/lgtm` 和 `/approve` 标签。 -- 合并已经就绪的,或关闭不应该接受的 PR。 -- 每天对新增的 Issue 报告进行分类和判别。有关 SIG 文档如何使用 metadata 的准则,请参见 - [对 Issue 进行分类](/zh/docs/contribute/review/for-approvers/#triage-and-categorize-issues)。 - - -### 对于管理人有用的 GitHub 查询 - -执行管理操作时,以下查询很有用。完成以下三个查询后,剩余的要审阅的 PR 列表通常很小。 -这些查询都排除了本地化的 PR,并仅包含 `master` 分支上的 PR(除了最后一个查询)。 - - -- [没有签署 CLA, 不能合并](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+label%3A%22cncf-cla%3A+no%22+-label%3Ado-not-merge+label%3Alanguage%2Fen): - 提醒贡献者签署 CLA。如果机器人和审阅者都已经提醒他们,请关闭 PR,并提醒他们在签署 CLA 后可以重新提交。 - **在作者没有签署 CLA 之前,不要审阅他们的 PR!** -- [需要 LGTM](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr+-label%3Ado-not-merge+label%3Alanguage%2Fen+-label%3Algtm+): - 如果需要技术审查,请告知机器人所建议的审阅者。如果 PR 需要文档审查或复制编辑,提交更改建议或向 PR 提交一个 copyedit 以使之进入下一步。 -- [有 LGTM ,需要批准](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+-label%3Ado-not-merge+label%3Alanguage%2Fen+label%3Algtm): - 确定 PR 是否需要进行其他更改或更新才能合并。如果您认为 PR 已准备好合并,请输入 `/approve`。 -- [快速批阅](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+):对于针对 master 分支的小规模 PR,可以快速审阅。 - 在浏览 PR 时,可以注意到 size 标签为 "XS" 的 PRs。 -- [非 master 分支的 PR](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr+-label%3Ado-not-merge+label%3Alanguage%2Fen+-base%3Amaster): - 如果 PR 针对 `dev-` 分支,则表示它适用于即将发布的版本。请添加带有 `/assign @<负责人的 github 账号>` 的注释,确保[发行版本负责人](https://github.com/kubernetes/sig-release/tree/master/release-team)注意到该 PR。如果 PR 是针对旧分支,请帮助 PR 作者确定是否所针对的是最合适的分支。 - - -### 什么时候关闭 PR - -审查和批准是缩短和更新我们的 PR 队列的一种方式;另一种方式是关闭 PR。 - - -- 关闭两个星期未签署 CLA 的 PR。 - PR 作者可以在签署 CLA 后重新打开 PR,因此这是确保未签署 CLA 的 PR 不会被合并的一种风险较低的方法。 - -- 如果作者在两周或更长时间内未回复评论或反馈,请关闭 PR。 - -不要害怕关闭 PR。贡献者可以轻松地重新打开并继续工作。通常,关闭通知会激励作者继续完成其贡献。 - -要关闭 PR,请在 PR 上输入 `/close`。 - - - -{{< note >}} -一项名为 [`fejta-bot`](https://github.com/fejta-bot) 的自动服务会在 Issue 停滞 90 -天后自动将其标记为过期;然后再等 30 天,如果仍然无人过问,则将其关闭。 -PR 管理者应该在 issues 处于无人过问状态 14-30 天后关闭它们。 -{{< /note >}} - + + + +SIG Docs 的[批准人(Approvers)](/zh/docs/contribute/participating/#approvers)们每周轮流负责 +[管理仓库的 PRs](https://github.com/kubernetes/website/wiki/PR-Wranglers)。 + +本节介绍 PR 管理者的职责。关于如何提供较好的评审意见,可参阅 +[评审变更](/zh/docs/contribute/review/). + + + + +## 职责 {#duties} +在为期一周的轮值期内,PR 管理者要: + +- 每天对新增的 Issues 判定和打标签。参见 + [对 Issues 进行判定和分类](/zh/docs/contribute/review/for-approvers/#triage-and-categorize-issues) + 以了解 SIG Docs 如何使用元数据的详细信息。 +- 检查[悬决的 PR](https://github.com/kubernetes/website/pulls) 的质量并确保它们符合 + [样式指南](/zh/docs/contribute/style/style-guide/)和 + [内容指南](/zh/docs/contribute/style/content-guide/)要求。 + + - 首先查看最小的 PR(`size/XS`),然后逐渐扩展到最大的 + PR(`size/XXL`),尽可能多地评审 PR。 +- 确保贡献者完成 [CLA](https://github.com/kubernetes/community/blob/master/CLA.md) 签署。 + - 使用[此脚本](https://github.com/zparnold/k8s-docs-pr-botherer)自动提醒尚未签署 + CLA 的贡献者签署 CLA。 +- 针对提供提供反馈,请求其他 SIG 的成员进行技术审核。 + - 为 PR 所建议的内容更改提供就地反馈。 + - 如果您需要验证内容,请在 PR 上发表评论并要求贡献者提供更多细节。 + - 设置相关的 `sig/` 标签。 + - 如果需要,从文件开头的 `reviewers:` 块中指派评阅人。 +- 使用 `/approve` 评论来批准可以合并的 PR,在 PR 就绪时将其合并。 + - PR 在被合并之前,应该有来自其他成员的 `/lgtm` 评论。 + - 可以考虑接受那些技术上准确,但文风上不满足 + [风格指南](/zh/docs/contribute/style/style-guide/)要求的 PR。 + 可以登记一个新的 Issue 来解决文档风格问题,并将其标记为 `good first issue`。 + + +### 对于管理人有用的 GitHub 查询 + +执行管理操作时,以下查询很有用。完成以下这些查询后,剩余的要审阅的 PR 列表通常很小。 +这些查询都不包含本地化的 PR,并仅包含主分支上的 PR(除了最后一个查询)。 + + +- [未签署 CLA,不可合并的 PR](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+label%3A%22cncf-cla%3A+no%22+-label%3Ado-not-merge+label%3Alanguage%2Fen): + 提醒贡献者签署 CLA。如果机器人和审阅者都已经提醒他们,请关闭 PR,并提醒他们在签署 CLA 后可以重新提交。 + **在作者没有签署 CLA 之前,不要审阅他们的 PR!** + +- [需要 LGTM](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr+-label%3Ado-not-merge+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+label%3Alanguage%2Fen+label%3Algtm): + 列举需要 `/approve` 评论来合并的 PR。 +- [快速批阅](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+): + 列举针对主分支的、没有明确合并障碍的 PR。 + 在浏览 PR 时,可以将 "XS" 尺寸标签更改为 "S"、"M"、"L"、"XL"、"XXL"。 +- [非主分支的 PR](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr+-label%3Ado-not-merge+label%3Alanguage%2Fen+-base%3Amaster): + 如果 PR 针对 `dev-` 分支,则表示它适用于即将发布的版本。 + 请添加带有 `/assign @<负责人的 github 账号>`,将其指派给 + [发行版本负责人](https://github.com/kubernetes/sig-release/tree/master/release-team)。 + 如果 PR 是针对旧分支,请帮助 PR 作者确定是否所针对的是最合适的分支。 + + +### 何时关闭 PR {#when-to-close-pull-requests} + +审查和批准是缩短和更新我们的 PR 队列的一种方式;另一种方式是关闭 PR。 + +当以下条件满足时,可以关闭 PR: + +- 作者两周内未签署 CLA。 + PR 作者可以在签署 CLA 后重新打开 PR,因此这是确保未签署 CLA 的 PR 不会被合并的一种风险较低的方法。 + +- 作者在两周或更长时间内未回复评论或反馈。 + +不要害怕关闭 PR。贡献者可以轻松地重新打开并继续工作。 +通常,关闭通知会激励作者继续完成其贡献。 + +要关闭 PR,请在 PR 上输入 `/close` 评论。 + + +{{< note >}} +一个名为 [`fejta-bot`](https://github.com/fejta-bot) 的自动服务会在 Issue 停滞 90 +天后自动将其标记为过期;然后再等 30 天,如果仍然无人过问,则将其关闭。 +PR 管理者应该在 issues 处于无人过问状态 14-30 天后关闭它们。 +{{< /note >}} + diff --git a/content/zh/docs/contribute/participate/roles-and-responsibilties.md b/content/zh/docs/contribute/participate/roles-and-responsibilties.md index 313c1ff5a4235..5fa2a43832dcd 100644 --- a/content/zh/docs/contribute/participate/roles-and-responsibilties.md +++ b/content/zh/docs/contribute/participate/roles-and-responsibilties.md @@ -133,7 +133,7 @@ After submitting at least 5 substantial pull requests and meeting the other [req 2. Open a GitHub issue in the [`kubernetes/org`](https://github.com/kubernetes/org/) repository. Use the **Organization Membership Request** issue template. --> 1. 找到两个[评审人](#reviewers)或[批准人](#approvers)为你的成员身份提供 - [担保](/docs/contribute/advanced#sponsor-a-new-contributor)。 + [担保](/zh/docs/contribute/advanced#sponsor-a-new-contributor)。 通过 [Kubernetes Slack 上的 #sig-docs 频道](https://kubernetes.slack.com) 或者 [SIG Docs 邮件列表](https://groups.google.com/forum/#!forum/kubernetes-sig-docs) @@ -277,7 +277,8 @@ in the `kubernetes/website` repository. 2. Assign the PR to one or more SIG-Docs approvers (user names listed under `sig-docs-{language}-owners`). -If approved, a SIG Docs lead adds you to the appropriate GitHub team. Once added, [K8s-ci-robot](https://github.com/kubernetes/test-infra/tree/master/prow#bots-home) assigns and suggests you as a reviewer on new pull requests. +If approved, a SIG Docs lead adds you to the appropriate GitHub team. Once added, +[@k8s-ci-robot](https://github.com/kubernetes/test-infra/tree/master/prow#bots-home) assigns and suggests you as a reviewer on new pull requests. --> 1. 发起 PR,将你的 GitHub 用户名添加到 `kubernetes/website` 仓库中 [OWNERS_ALIASES](https://github.com/kubernetes/website/blob/master/OWNERS) @@ -291,7 +292,7 @@ If approved, a SIG Docs lead adds you to the appropriate GitHub team. Once added 下列举的用户名)。 请求被批准之后,SIG Docs Leads 之一会将你添加到合适的 GitHub 团队。 -一旦添加完成, [K8s-ci-robot](https://github.com/kubernetes/test-infra/tree/master/prow#bots-home) +一旦添加完成, [@k8s-ci-robot](https://github.com/kubernetes/test-infra/tree/master/prow#bots-home) 会在处理未来的 PR 时,将 PR 指派给你或者建议你来评审某 PR。 +- 阅读[管理 PR](/zh/docs/contribute/participate/pr-wranglers/),了解所有批准人轮值的一个角色。 +