角色和职责

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

  • 任何人:Kubernetes 文档的常规贡献者
  • 成员:可以分配和分类问题,并对拉取请求提供非约束性审查
  • 审查者:可以主导文档拉取请求的审查,并可以保证变更的质量
  • 审批者:可以主导文档审查并合并更改

任何人

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

任何人都可以

签署 CLA 后,任何人也可以

  • 开启一个拉取请求来改进现有内容、添加新内容或撰写博客文章或案例研究
  • 创建图表、图形资源以及可嵌入的屏幕录像和视频

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

成员

成员是指已向 kubernetes/website 提交多个拉取请求的人。成员是 Kubernetes GitHub 组织的一部分。

成员可以

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

  • 使用 /lgtm 注释向拉取请求添加 LGTM(对我来说很好)标签

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

  • 使用 /assign 注释为拉取请求分配审阅者

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

  • 使用自动化来分类和分类问题

  • 编写新功能文档

成为成员

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

  1. 找到两位审阅者审批者赞助您的会员资格。

    Slack 上的 #sig-docs 频道SIG Docs 邮件列表中请求赞助。

  2. kubernetes/org 存储库中打开一个 GitHub 问题。使用 组织成员资格请求 问题模板。

  3. 让您的赞助商了解 GitHub 问题。您可以

    • 在问题中提及他们的 GitHub 用户名(@<GitHub-用户名>

    • 使用 Slack 或电子邮件向他们发送问题链接。

      赞助商将以 +1 投票批准您的请求。一旦您的赞助商批准了该请求,Kubernetes GitHub 管理员会将您添加为成员。恭喜您!

      如果您的会员资格请求未被接受,您将收到反馈。解决反馈后,再次申请。

  4. 在您的电子邮件帐户中接受加入 Kubernetes GitHub 组织的邀请。

审阅者

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

审阅者可以

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

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

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

  • 改进代码注释

您可以成为 SIG Docs 审阅者,或者成为特定主题领域的文档审阅者。

将审阅者分配给拉取请求

自动化会将审阅者分配给所有拉取请求。您可以通过评论来请求特定人员进行审查:/assign [@_github_handle]

如果指定的审阅者没有对 PR 发表评论,则另一位审阅者可以介入。您还可以根据需要分配技术审阅者。

使用 /lgtm

LGTM 代表“对我来说很好”,表示拉取请求在技术上准确且可以合并。所有 PR 都需要来自审阅者的 /lgtm 注释和来自审批者的 /approve 注释才能合并。

来自审阅者的 /lgtm 注释具有约束力,并会触发自动化,从而添加 lgtm 标签。

成为审阅者

当您满足 要求时,您可以成为 SIG Docs 审阅者。其他 SIG 中的审阅者必须单独申请 SIG Docs 中的审阅者身份。

申请方法

  1. 打开一个拉取请求,将您的 GitHub 用户名添加到 kubernetes/website 存储库中的OWNERS_ALIASES文件的某个部分。

  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 测试是否通过。

    Netlify tests must pass before approving
  • 访问 PR 的 Netlify 页面预览,以确保在批准之前看起来不错。

  • 参与每周轮换的PR 处理人轮换计划。SIG Docs 希望所有审批者都参与此轮换。有关更多详细信息,请参阅PR 处理人

成为审批者

当您满足 要求时,您可以成为 SIG Docs 审批者。其他 SIG 中的审批者必须单独申请 SIG Docs 中的审批者身份。

申请方法

  1. 打开一个拉取请求,将自己添加到 kubernetes/website 存储库中的 OWNERS_ALIASES 文件的某个部分。

  2. 将 PR 分配给一个或多个当前的 SIG Docs 审批者。

如果获得批准,SIG Docs 主管会将您添加到相应的 GitHub 团队。添加后,@k8s-ci-robot 会在新的拉取请求中分配并建议您作为审阅者。

下一步是什么

  • 阅读关于PR 处理的信息,这是一个所有审批者轮流承担的角色。
上次修改时间:2022 年 9 月 28 日下午 12:20 PST:在 sig-docs 贡献者角色中重新措辞 (35621ef457)