角色和职责

任何人都可以为 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 问题。使用 **Organization Membership Request** 问题模板。

  3. 让您的担保人知道 GitHub 问题。您可以选择

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

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

      担保人将用 +1 投票批准您的请求。一旦您的担保人批准请求,Kubernetes GitHub 管理员就会将您添加为成员。恭喜!

      如果您的成员请求未被接受,您将收到反馈。在处理完反馈后,请再次申请。

  4. 接受您邮箱账户中 Kubernetes 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 文件中的一个部分。

  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: Reword in sig-docs contributor roles (35621ef457)