PR 协调员

SIG Docs 审批者 轮流每周 管理拉取请求。

本节介绍 PR 协调员的职责。有关如何进行良好审查的更多信息，请参阅 审查变更。

职责

每周轮班担任 PR 协调员的每天

  • 审查 打开的拉取请求，检查其质量是否符合 样式 和 内容 指南。
    • 从最小的 PR（size/XS）开始，最后是最大的（size/XXL）。尽可能多地审查 PR。
  • 确保 PR 贡献者签署了 CLA。
    • 使用 此 脚本提醒未签署 CLA 的贡献者签署。
  • 提供变更反馈，并向其他 SIG 的成员请求技术审查。
    • 为建议的内容变更在 PR 中提供内联建议。
    • 如果您需要验证内容，请在 PR 中发表评论并请求更多详细信息。
    • 分配相关的 sig/ 标签。
    • 如果需要，从文件的前端数据中的 reviewers: 块中分配审阅者。
    • 您也可以通过在 PR 上评论 @kubernetes/<sig>-pr-reviews 来标记 SIG 以进行审查。
  • 使用 /approve 评论批准 PR 以合并。准备好后合并 PR。
    • PR 应具有来自其他成员的 /lgtm 评论，然后才能合并。
    • 考虑接受技术上准确但未满足 样式指南 的内容。当您批准更改时，打开一个新问题来解决样式问题。通常可以将这些样式修复问题写为 良好的首个问题。
    • 将样式修复作为良好的首个问题是一个很好的方法，可以确保提供更轻松的任务来帮助新贡献者加入。
  • 还要检查针对 参考文档生成器 代码的拉取请求，并审查这些请求（或寻求帮助）。
  • 支持 问题协调员 每天对传入问题进行分类和标记。请参阅 分类和标记问题，了解 SIG Docs 如何使用元数据的指南。

对协调员有用的 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 @<manager's_github-username>。如果 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>

何时关闭拉取请求

审查和批准是缩短我们的 PR 队列并保持其最新状态的一种工具。另一个工具是关闭。

关闭以下情况的 PR：

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

    作者可以在签署 CLA 后重新打开 PR。这是一种低风险的方式，可以确保没有任何内容未经签署 CLA 就合并。

  • 作者在 2 周或更长时间内未回复评论或反馈。

不要害怕关闭拉取请求。贡献者可以轻松地重新打开并恢复正在进行的工作。通常，关闭通知会促使作者恢复并完成他们的贡献。

要关闭拉取请求，请在 PR 上留下 /close 评论。

PR 协调员影子计划

在 2021 年后期，SIG Docs 推出了 PR 协调员影子计划。该计划的推出是为了帮助新贡献者了解 PR 协调流程。

成为影子

最后修改时间：2024 年 3 月 19 日 下午 1:03 PST：修复 Markdown (2f55942c7e)