角色和职责

任何人都可以为 Kubernetes 贡献。随着你对 SIG Docs 的贡献增加，你可以在社区中申请不同级别的成员资格。这些角色允许你在社区中承担更多责任。每个角色都需要更多时间和承诺。这些角色包括：

• 任何人： Kubernetes 文档的普通贡献者
• 成员： 可以指派（assign）和分诊（triage）问题，并对拉取请求（pull request）提供非约束性审阅
• 审阅者： 可以主导文档拉取请求的审阅，并对变更的质量背书
• 批准者： 可以主导文档审阅并合并（merge）变更

任何人

任何拥有 GitHub 账户的人都可以为 Kubernetes 贡献。SIG Docs 欢迎所有新贡献者！

任何人都可以：

• 在任何 Kubernetes 仓库（包括 kubernetes/website）中开启一个 Issue
• 对拉取请求提供非约束性反馈
• 为本地化贡献
• 在 Slack 或 SIG Docs 邮件列表上提出改进建议。

签署 CLA 后，任何人还可以：

• 发起拉取请求来改进现有内容、添加新内容，或者撰写博客文章或案例研究
• 创建图表、图形资源以及可嵌入的截屏和视频

有关更多信息，请参阅贡献新内容。

成员

成员是指那些已向 kubernetes/website 提交了多个拉取请求的人。成员属于 Kubernetes GitHub 组织。

成员可以：

• 执行 任何人 下面列出的所有操作

• 使用 /lgtm 注释为拉取请求添加 LGTM（Looks Good To Me，我认为不错）标签

  注意

  使用 /lgtm 会触发自动化。如果你想提供非约束性的批准，评论“LGTM”也可以！

• 使用 /hold 注释来阻止拉取请求合并

• 使用 /assign 注释为拉取请求指派审阅者

• 对拉取请求提供非约束性审阅

• 使用自动化工具分诊和分类 Issue

• 记录新特性

成为成员

提交至少 5 个实质性拉取请求并满足其他要求后：

1. 找到两名审阅者或批准者来担保你的成员资格。

   在 Slack 上的 #sig-docs 频道或 SIG Docs 邮件列表上寻求担保。

   注意

   不要直接向某个 SIG Docs 成员发送电子邮件或 Slack 直接消息。在提交申请之前，你必须先请求担保。

2. 在 kubernetes/org 仓库中开启一个 GitHub Issue。使用组织成员资格申请 (Organization Membership Request) Issue 模板。

3. 将 GitHub Issue 通知给你的担保人。你可以选择以下方式：

   • 在 Issue 中提及他们的 GitHub 用户名（@<GitHub 用户名>）

   • 通过 Slack 或电子邮件发送 Issue 链接给他们。

     担保人将以 +1 投票批准你的申请。担保人批准申请后，Kubernetes GitHub 管理员会将你添加为成员。恭喜你！

     如果你的成员资格申请未被接受，你会收到反馈。在解决了反馈的问题后，可以再次申请。

4. 接受你的电子邮件账户中收到的 Kubernetes GitHub 组织的邀请。

   注意

   GitHub 会将邀请发送到你账户中的默认电子邮件地址。

审阅者

审阅者负责审阅开放的拉取请求。与成员反馈不同，PR 作者必须解决审阅者的反馈。审阅者是 @kubernetes/sig-docs-{language}-reviews GitHub 团队的成员。

审阅者可以：

• 执行 任何人 和 成员 下面列出的所有操作

• 审阅拉取请求并提供约束性反馈

  注意

  要提供非约束性反馈，请在评论前面加上诸如“可选：”之类的短语。

• 编辑代码中面向用户的字符串

• 改进代码注释

你可以成为 SIG Docs 的审阅者，或者某个特定主题领域的文档审阅者。

指派审阅者给拉取请求

自动化工具会为所有拉取请求指派审阅者。你可以通过评论 /assign [@_github_handle] 来请求特定人员进行审阅。

如果指派的审阅者未在 PR 上评论，其他审阅者可以介入。你也可以根据需要指派技术审阅者。

使用 /lgtm

LGTM 代表 "Looks good to me"（我认为不错），表示拉取请求在技术上是准确的，可以合并。所有 PR 都需要一名审阅者的 /lgtm 评论和一名批准者的 /approve 评论才能合并。

来自审阅者的 /lgtm 评论是约束性的，会触发自动化工具添加 lgtm 标签。

成为审阅者

当你满足要求后，你可以成为 SIG Docs 的审阅者。其他 SIG 的审阅者必须单独申请 SIG Docs 的审阅者身份。

如何申请：

1. 开启一个拉取请求，将你的 GitHub 用户名添加到 kubernetes/website 仓库中 OWNERS_ALIASES 文件的一个部分。

   注意

   如果你不确定将自己添加到哪里，可以添加到 sig-docs-en-reviews。

2. 将 PR 指派给一名或多名 SIG Docs 批准者（用户列表在 sig-docs-{language}-owners 下）。

如果获得批准，SIG Docs 的负责人会将你添加到相应的 GitHub 团队。添加后，K8s-ci-robot 会在新拉取请求中指派并建议你作为审阅者。

批准者

批准者审阅并批准拉取请求以便合并。批准者是 @kubernetes/sig-docs-{language}-owners GitHub 团队的成员。

批准者可以执行以下操作：

• 执行 任何人、成员 和 审阅者 下面列出的所有操作
• 使用 /approve 注释批准和合并拉取请求，发布贡献者的内容
• 提出风格指南的改进建议
• 提出文档测试的改进建议
• 提出 Kubernetes 网站或其他工具的改进建议

如果 PR 已经有了 /lgtm，或者如果批准者也评论了 /lgtm，PR 会自动合并。SIG Docs 批准者只应对不需要额外技术审阅的变更留下 /lgtm。

批准拉取请求

批准者和 SIG Docs 负责人是唯一可以合并拉取请求到网站仓库的人。这伴随着一定的责任。

• 批准者可以使用 /approve 命令，它将 PR 合并到仓库中。

  警告

  不小心合并可能会破坏网站，因此当你合并某些内容时，务必确定你理解其含义。

• 确保提议的变更符合文档内容指南。

  如果你有任何疑问，或者对某些事情不确定，请随时请求额外的审阅。

• 在你 /approve PR 之前，验证 Netlify 测试是否通过。

  

• 访问 PR 的 Netlify 页面预览，在批准前确保内容看起来不错。

• 参与每周轮换的 PR Wrangler 轮换计划。SIG Docs 要求所有批准者参与此轮换。更多详情请参阅PR Wranglers。

成为批准者

当你满足要求后，你可以成为 SIG Docs 的批准者。其他 SIG 的批准者必须单独申请 SIG Docs 的批准者身份。

如何申请：

1. 开启一个拉取请求，将你自己添加到 kubernetes/website 仓库中 OWNERS_ALIASES 文件的一个部分。

   注意

   If you aren't sure where to add yourself, add yourself to `sig-docs-en-owners`.
   

2. 将 PR 指派给一名或多名现有的 SIG Docs 批准者。

如果获得批准，SIG Docs 的负责人会将你添加到相应的 GitHub 团队。添加后，@k8s-ci-robot 会在新拉取请求中指派并建议你作为审阅者。

下一步

• 阅读关于 PR Wrangling 的信息，这是所有批准者轮换承担的角色。