PR 管理员

SIG Docs 审批人轮流值班一周，管理代码仓库的拉取请求。

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

职责

作为 PR 管理员，在为期一周的值班时间内，您每天需要：

• 审查开放的拉取请求，确保其质量并符合风格和内容指南。
  • 先从最小的 PR（size/XS）开始，最后处理最大的 PR（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 管理流程。

成为影子

• 如果您有兴趣成为 PR 管理员的影子，请访问PR 管理员 Wiki 页面，查看今年的 PR 管理时间表并注册。

• Kubernetes 组织成员可以编辑PR 管理员 Wiki 页面并注册在一周内成为现有 PR 管理员的影子。

• 其他人可以在#sig-docs Slack 频道上联系，请求在一周内成为指定 PR 管理员的影子。欢迎联系 Brad Topol (@bradtopol) 或SIG Docs 联席主席/负责人之一。

• 注册成为 PR 管理员的影子后，请在Kubernetes Slack上向 PR 管理员介绍自己。