PR 处理者

SIG Docs 的审批者(approvers)每周轮班管理仓库的 Pull Request

本节介绍 PR 协调员的职责。有关如何提供良好评审的更多信息,请参阅评审变更

职责

作为 PR 协调员每周轮班期间的每一天工作

  • 评审开放的 Pull Request 的质量,并确保其符合风格内容指南。
    • 从最小的 PR (size/XS) 开始,以最大的 (size/XXL) 结束。尽可能多地评审 PR。
  • 确保 PR 贡献者签署了 CLA
    • 使用脚本提醒尚未签署 CLA 的贡献者进行签署。
  • 就变更提供反馈,并要求其他 SIG 的成员进行技术评审。
    • 在 PR 中对建议的内容变更提供行内(inline)建议。
    • 如果需要验证内容,请在 PR 上发表评论并要求提供更多细节。
    • 分配相关的 sig/ 标签。
    • 如有需要,从文件 front matter 的 reviewers: 块中分配评审者。
    • 你还可以通过在 PR 上评论 @kubernetes/<sig>-pr-reviews 来标记某个 SIG 进行评审。
  • 使用 /approve 评论来批准合并 PR。准备就绪后合并 PR。
    • PR 在合并前应有另一名成员的 /lgtm 评论。
    • 可以考虑接受技术上正确但未完全符合风格指南的内容。在批准变更的同时,开启一个新的 Issue 来解决风格问题。你通常可以将这些风格修复 Issue 写为 好的首个 Issue
    • 将风格修复作为“好的首个 Issue”是确保有足够简单任务来帮助新贡献者上手的好方法。
  • 同时检查针对 参考文档生成器 代码的 Pull Request,并对其进行评审(或寻求帮助)。
  • 支持 Issue 协调员 每天对传入的 Issue 进行分流和标记。有关 SIG Docs 如何使用元数据的指导,请参阅 分流和分类 Issue

说明

PR 协调员的职责不适用于本地化 PR(非英语 PR)。本地化团队有自己的流程和团队来评审其语言的 PR。不过,确保语言 PR 被正确标记、评审小的非语言相关 PR(如链接更新),或在长期运行的 PR(即已开启超过 6 个月且一个月或更长时间未更新的 PR)中标记评审者或贡献者通常是有帮助的。

对协调员有帮助的 GitHub 查询

以下查询在协调时非常有用。完成这些查询后,剩余需要评审的 PR 列表通常就很小了。这些查询排除了本地化 PR。除最后一个查询外,所有查询均针对主分支。

  • 未签署 CLA,不可合并:提醒贡献者签署 CLA。如果机器人和人工都已提醒过他们,则关闭 PR 并提醒他们可以在签署 CLA 后重新打开。请勿评审作者未签署 CLA 的 PR!
  • 需要 LGTM:列出需要成员提供 LGTM 的 PR。如果 PR 需要技术评审,请拉入机器人建议的其中一位评审者。如果内容需要改进,请在行内添加建议和反馈。
  • 已有 LGTM,需要文档批准:列出需要 /approve 评论才能合并的 PR。
  • 快速获胜:列出针对主分支且没有明确阻碍因素的 PR。(在处理 PR 时更改尺寸标签中的“XS” [XS, S, M, L, XL, XXL])。
  • 非针对主分支:如果 PR 是针对 dev- 分支,则是为了即将到来的发布。请使用以下命令分配文档发布经理/assign @<经理的_github-用户名>。如果 PR 是针对旧分支,请帮助作者确定它是否应该针对最佳分支。

对协调员有帮助的 Prow 命令

# 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>

何时关闭 Pull Request

评审和批准是保持我们的 PR 队列简短和最新的工具之一。另一个工具是关闭。

关闭 PR 的情况:

  • 作者在两周内未签署 CLA。

    作者可以在签署 CLA 后重新打开 PR。这是一种低风险的方法,可确保在没有签署 CLA 的情况下不会合并任何内容。

  • 作者在 2 周或更长时间内未对评论或反馈做出回应。

不要害怕关闭 Pull Request。贡献者可以轻松重新打开并恢复工作。通常,关闭通知正是促使作者恢复并完成其贡献的动力。

要关闭 Pull Request,请在 PR 上留下 /close 评论。

说明

k8s-triage-robot 机器人在 90 天不活跃后将 Issue 标记为过期(stale)。再过 30 天,它会将 Issue 标记为腐烂(rotten)并将其关闭。PR 协调员应在 14-30 天不活跃后关闭 Issue。

PR 协调员影子计划

2021 年底,SIG Docs 引入了 PR 协调员影子计划。该计划旨在帮助新贡献者了解 PR 协调流程。

成为影子成员


最后修改时间:2026 年 4 月 14 日凌晨 1:15(太平洋标准时间):fix(links): update kubernetes/community links from master to main (03c191bcc4)