PR 协管员

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

本节介绍 PR 协管员的职责。关于如何提供好的审阅意见的更多信息，请参阅审阅变更。

职责

在 PR 协管员为期一周的轮班期间的每一天

• 审阅开放的 Pull Request，检查其质量并确保其遵守风格指南和内容指南。
  • 首先从最小的 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 评论。
  • 考虑接受技术上准确但不符合风格指南的内容。在批准变更的同时，开启一个新的 Issue 来处理风格问题。你通常可以将这些风格修复 Issue 写成新手友好任务 (good first issues)。
  • 将风格修复作为新手友好任务是确保有更容易的任务来帮助新贡献者入门的好方法。
• 还要检查针对参考文档生成器代码的 Pull Request，并审阅这些（或请人协助）。
• 协助Issue 协管员每日对新进 Issue 进行分类和打标签。关于 SIG Docs 如何使用元数据的指南，请参阅分类和标记 Issue (Triage and categorize issues)。

对协管员有用的 GitHub 查询

以下查询在进行协管工作时非常有用。处理完这些查询后，剩余需要审阅的 PR 列表通常很短。这些查询不包括本地化 PR。除了最后一个查询外，所有查询都是针对 main 分支的。

• 未签署 CLA，不符合合并条件：提醒贡献者签署 CLA。如果机器人和人工都已提醒过，则关闭该 PR，并提醒他们在签署 CLA 后可以重新开启。不要审阅作者未签署 CLA 的 PR！
• 需要 LGTM：列出需要成员提供 LGTM 的 PR。如果 PR 需要技术审阅，请联系机器人建议的审阅者。如果内容需要修改，请在线添加建议和反馈。
• 已有 LGTM，需要文档批准：列出需要 /approve 评论才能合并的 PR。
• 快速胜利 (Quick Wins)：列出针对 main 分支且没有明显阻塞问题的 PR。（在处理 PR 时，根据 PR 大小更改 size 标签中的 "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>

何时关闭 Pull Request

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

在以下情况下关闭 PR：

• 作者在两周内没有签署 CLA。

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

• 作者在两周或更长时间内没有回复评论或反馈。

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

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

PR 协管员“影子”计划

2021 年末，SIG Docs 推出了 PR 协管员“影子”计划。该计划旨在帮助新贡献者理解 PR 协管流程。

成为“影子”成员

• 如果你有兴趣作为 PR 协管员进行“影子”跟岗，请访问PR Wranglers Wiki 页面查看今年的 PR 协管日程表并报名。

• 其他人可以在#sig-docs Slack 频道联系，请求在特定一周跟随指定的 PR 协管员进行“影子”跟岗。随时联系 Brad Topol (@bradtopol) 或任意一位SIG Docs 联合主席/负责人。

• 一旦你报名成为 PR 协管员的“影子”，请在Kubernetes Slack上向该 PR 协管员介绍自己。