diff --git a/content/zh-cn/docs/contribute/review/for-approvers.md b/content/zh-cn/docs/contribute/review/for-approvers.md index e85ebc4c1f6..f9a557011b2 100644 --- a/content/zh-cn/docs/contribute/review/for-approvers.md +++ b/content/zh-cn/docs/contribute/review/for-approvers.md @@ -15,13 +15,16 @@ weight: 20 ## 评阅 PR @@ -55,17 +61,20 @@ Kubernetes 文档遵循 [Kubernetes 代码评阅流程](https://github.com/kuber 不过评阅人和批准人还要做以下工作: - 根据需要使用 Prow 命令 `/assign` 指派特定的评阅人。如果某个 PR 需要来自代码贡献者的技术审核时,这一点非常重要。 @@ -108,13 +117,6 @@ true: - If the PR author pushed their branch directly to the [https://github.com/kubernetes/website/](https://github.com/kubernetes/website/) repository. Only a reviewer with push access can commit to another user's PR. - - {{< note >}} - Encourage the author to push their branch to their fork before - opening the PR next time. - {{< /note >}} - -- The PR author explicitly disallows edits from approvers. --> 如果处于下列情况之一,你不可以向别人的 PR 提交内容: @@ -123,9 +125,16 @@ true: 仓库。只有具有推送权限的评阅人才可以向他人的 PR 提交内容。 {{< note >}} + 我们应鼓励作者下次将分支推送到自己的克隆副本之后再发起 PR。 {{< /note >}} + - PR 作者明确地禁止批准人编辑他/她的 PR。 @@ -177,10 +188,13 @@ Prow 命令 | 角色限制 | 描述 要查看可以在 PR 中使用的命令,请参阅 [Prow 命令指南](https://prow.k8s.io/command-help?repo=kubernetes%2Fwebsite)。 + ### 评判 Issue {#triaging-an-issue} @@ -222,9 +237,10 @@ finds issues that might need triage. 在以上两种情况下,标签都必须合法存在。如果你尝试添加一个尚不存在的标签, 对应的命令会被悄悄忽略。 @@ -356,7 +375,9 @@ SIG Docs 常常会遇到以下类型的 Issue,因此对其处理方式描述 +### 压缩(Squashing)提交 + +作为一名 Approver,当你评审 PR 时,可能会遇到以下几种情况: + +- 建议贡献者压缩他们的提交。 +- 协助贡献者压缩提交。 +- 建议贡献者先不要压缩提交。 +- 阻止压缩提交。 + + +**建议贡献者压缩提交**:新贡献者可能不知道要压缩 PR 中的提交。 +如果是这种情况,Approver 要给出压缩提交的建议,并贴附有用的链接, +并在贡献者需要帮助时伸出援手。这里有一些有用的链接: + +- 协助文档贡献者[提 PR 和压缩提交](/zh-cn/docs/contribute/new-content/open-a-pr#squashing-commits)。 +- 面向开发者包括插图在内的 [GitHub 工作流程](https://www.k8s.dev/docs/guide/github-workflow/)。 + + +**协助贡献者压缩提交**:如果贡献者压缩提交遇到难题或合并 PR 的时间紧迫, +你可以协助贡献者执行压缩提交的操作。 + + +- kubernetes/website + 仓库[被配置为允许压缩提交后合并 PR](https://docs.github.com/zh/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests)。 + 你只需选择 **Squash commits** 按钮。 +- 在 PR 中,如果贡献者允许 Maintainer 们管理 PR,你就可以为他们压缩提交并将其 fork 更新为最新结果。 + 在你执行压缩提交之后,请建议贡献者将压缩后的提交拉到他们本地的克隆副本。 +- 你可以使用标签让 GitHub 压缩提交,这样 Tide / GitHub 就会对提交执行压缩; + 你还可以在合并 PR 时点选 **Squash commits** 按钮。 + + +**建议贡献者避免压缩提交** + +- 如果一个提交做了一些破坏性或不明智的修改,那最后一个提交可用于回滚错误,这种情况不要压缩提交。 + 即使通过 GitHub 上 PR 中的 "Files changed" 页签以及 Netlify 预览看起来都正常, + 合并这种 PR 可能会在其他 fork 中造成 rebase 或合并冲突。 + 你看到这种情况要进行合理的干预,避免对其他贡献者造成麻烦。 + + +**千万不要压缩提交** + +- 如果你为新版本发起了一次本地化批量作业或为新版发布许多文档,那你要合并到的分支将与用户 fork 的分支不同, + 这种情况**千万不要压缩提交**。之所以不压缩提交,是因为你必须保持这些文件的提交历史记录。