角色和职责
任何人都可以为 Kubernetes 贡献。随着您对 SIG Docs 的贡献不断增加,您可以申请社区不同级别的成员资格。这些角色允许您在社区中承担更多责任。每个角色都需要更多的时间和投入。这些角色是
- 任何人:定期为 Kubernetes 文档做出贡献者
- 成员:可以分配和处理问题,并对拉取请求提供非约束性审查
- 审查者:可以领导文档拉取请求的审查,并可以证明变更的质量
- 批准者:可以领导文档审查并合并变更
任何人
拥有 GitHub 帐户的任何人都可以为 Kubernetes 贡献。SIG Docs 欢迎所有新贡献者!
任何人可以
- 在任何 Kubernetes 仓库中打开 issue,包括
kubernetes/website - 对拉取请求提供非约束性反馈
- 贡献本地化
- 在 Slack 或 SIG docs 邮件列表上提出改进建议。
在 签署 CLA 后,任何人还可以
- 打开拉取请求以改进现有内容、添加新内容或撰写博客文章或案例研究
- 创建图表、图形资产以及可嵌入的屏幕录像和视频
有关更多信息,请参阅 贡献新内容。
成员
成员是指向 kubernetes/website 提交过多个拉取请求的人。成员是 Kubernetes GitHub 组织 的一部分。
成员可以
执行 任何人 下列出的所有操作
使用
/lgtm命令向拉取请求添加 LGTM(看起来不错)标签说明
使用/lgtm会触发自动化。如果您想提供非约束性批准,评论“LGTM”也可以!使用
/hold命令阻止合并拉取请求使用
/assign命令将审查者分配给拉取请求对拉取请求提供非约束性审查
使用自动化来处理和分类 issue
记录新功能
成为成员
在提交至少 5 个实质性的拉取请求并满足其他 要求 后
在 Slack 上的 #sig-docs 频道 或在 SIG Docs 邮件列表上请求赞助。
说明
不要直接通过电子邮件或 Slack 直接消息向单个 SIG Docs 成员发送消息。您必须在提交申请之前请求赞助。在
kubernetes/org仓库中打开 GitHub issue。使用 组织成员资格请求 issue 模板。让您的赞助者了解 GitHub issue。您可以
在 issue 中提及他们的 GitHub 用户名 (
@<GitHub-username>)通过 Slack 或电子邮件向他们发送 issue 链接。
赞助者将通过
+1投票批准您的请求。一旦您的赞助者批准了请求,Kubernetes GitHub 管理员会将您添加为成员。恭喜!如果您的成员资格请求未被接受,您将收到反馈。在解决反馈后,再次申请。
在您的电子邮件帐户中接受 Kubernetes GitHub 组织的邀请。
说明
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 中的审查者身份。
要申请
打开一个拉取请求,将您的 GitHub 用户名添加到
kubernetes/website仓库中的 OWNERS_ALIASES 文件的一个部分。说明
如果您不确定将自己添加到哪里,请将自己添加到sig-docs-en-reviews。将 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 合并到仓库中。警告
粗心的合并可能会破坏站点,因此请确保在合并内容时,您是认真的。确保拟议的变更符合 文档内容指南。
如果您有任何疑问,或者不确定某些事情,请随时要求进行其他审查。
在您
/approvePR 之前,请验证 Netlify 测试是否通过。
访问 Netlify 页面预览 PR,以确保在批准之前一切看起来都很好。
参与 PR Wrangler 轮换计划 进行每周轮换。SIG Docs 期望所有批准者都参与此轮换。请参阅 PR wrangler 以获取更多详细信息。
成为批准者
当您满足 要求 时,您可以成为 SIG Docs 批准者。其他 SIG 中的批准者必须单独申请 SIG Docs 中的批准者身份。
要申请
打开一个拉取请求,将您添加到
kubernetes/website仓库中的 OWNERS_ALIASES 文件的一个部分。说明
If you aren't sure where to add yourself, add yourself to `sig-docs-en-owners`.将 PR 分配给一个或多个当前的 SIG Docs 批准者。
如果获得批准,SIG Docs 负责人会将您添加到适当的 GitHub 团队。添加后,@k8s-ci-robot 会将您分配为新拉取请求的审查者并建议您。
接下来
- 阅读关于 PR wrangling 的内容,这是所有批准者轮流承担的角色。