PR 协调员

SIG Docs 的 审批员 负责为仓库管理拉取请求（pull request），轮班期为一周。

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

职责

每周一次，作为 PR 协调员的轮班日

• 审阅未处理的拉取请求，确保其质量并符合样式和内容指南。
  • 先从最小的 PR（size/XS）开始，最后处理最大的（size/XXL）。尽量多审阅 PR。
• 确保 PR 贡献者已签署CLA。
  • 使用此脚本提醒尚未签署 CLA 的贡献者签署。
• 对更改提供反馈，并请求其他 SIG 成员进行技术审阅。
  • 在 PR 中对建议的内容更改提供内联建议。
  • 如果您需要验证内容，请在 PR 中留下评论并要求更多详细信息。
  • 分配相关的 sig/ 标签。
  • 如有必要，从文件 front matter 中的 reviewers: 块中分配审阅者。
  • 您还可以通过在 PR 中评论 @kubernetes/<sig>-pr-reviews 来标记一个SIG进行审阅。
• 使用 /approve 评论批准 PR 以合并。准备就绪后合并 PR。
  • PR 在合并之前应获得另一位成员的 /lgtm 评论。
  • 可以接受技术上准确但未满足样式指南的内容。在批准更改的同时，打开一个新问题来解决样式问题。您通常可以将这些样式修复问题写成“good first issue”。
  • 将样式修复用作“good first issue”是确保提供更多简单任务以帮助新贡献者入职的好方法。
• 另外，检查针对参考文档生成器代码的拉取请求，并审阅这些请求（或寻求帮助）。
• 支持问题协调员，以便每天分类和标记传入的问题。有关 SIG Docs 如何使用元数据的指南，请参阅分类和标记问题。

PR 协调员的实用 GitHub 查询

以下查询在协调时很有用。在处理完这些查询后，剩余的 PR 审阅列表通常会很小。这些查询不包括本地化 PR。除最后一个查询外，所有查询都针对主分支。

• 无 CLA，不可合并：提醒贡献者签署 CLA。如果机器人和人类都提醒过他们，请关闭 PR 并提醒他们签署 CLA 后可以重新打开。请勿审阅作者未签署 CLA 的 PR！
• 需要 LGTM：列出需要成员 LGTM 的 PR。如果 PR 需要技术审阅，请使用机器人建议的审阅者之一。如果内容需要修改，请在内联添加建议和反馈。
• 已有 LGTM，需要文档批准：列出需要 /approve 评论才能合并的 PR。
• 快速获胜：列出针对主分支的 PR，没有明显障碍。（在处理 PR 时更改 size 标签中的“XS” [XS, S, M, L, XL, XXL]）。
• 未针对主分支：如果 PR 是针对 dev- 分支的，则表示即将发布的版本。使用 /assign @<manager's_github-username> 分配文档发布经理。如果 PR 是针对旧分支的，请帮助作者弄清楚其目标分支是否是最佳分支。

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 的 PR 被合并的低风险方法。

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

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

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

PR 协调员见习计划

2021 年末，SIG Docs 推出了 PR 协调员见习计划。该计划的目的是帮助新贡献者理解 PR 协调过程。

成为见习者

• 如果您有兴趣作为 PR 协调员见习，请访问PR 协调员 Wiki 页面，查看今年的 PR 协调计划并进行注册。

• 其他人可以通过#sig-docs Slack 频道联系，请求在特定的一周内见习已分配的 PR 协调员。请随时联系SIG Docs 联合主席/负责人。

• 一旦您注册为 PR 协调员见习，请在Kubernetes Slack上向 PR 协调员介绍自己。