角色和职责
任何人都可以为 Kubernetes 贡献。随着您对 SIG Docs 的贡献的增长,您可以申请社区的不同成员级别。这些角色使您能够在社区中承担更多责任。每个角色都需要更多时间和投入。这些角色是
- 任何人:Kubernetes 文档的定期贡献者
- 成员:可以分配和分类问题,并对拉取请求提供非约束性审查
- 审阅者:可以领导对文档拉取请求的审查,并可以保证更改的质量
- 批准者:可以领导对文档的审查并合并更改
任何人
任何拥有 GitHub 帐户的人都可以为 Kubernetes 贡献。SIG Docs 欢迎所有新贡献者!
任何人都可以
- 在任何 Kubernetes 存储库中打开问题,包括
kubernetes/website
- 对拉取请求提供非约束性反馈
- 为本地化做出贡献
- 在 Slack 或 SIG docs 邮件列表 上建议改进。
在 签署 CLA 后,任何人都可以
- 打开拉取请求以改进现有内容,添加新内容,或撰写博客文章或案例研究
- 创建图表、图形资产以及可嵌入的屏幕截图和视频
有关更多信息,请参阅 贡献新内容。
成员
成员是指已向 kubernetes/website
提交多个拉取请求的人员。成员是 Kubernetes GitHub 组织 的一部分。
成员可以
执行 任何人 下列出的所有操作
使用
/lgtm
评论在拉取请求中添加 LGTM(看起来不错)标签注意
使用/lgtm
会触发自动化。如果您想提供非约束性批准,则评论“LGTM”也可以!使用
/hold
评论阻止拉取请求的合并使用
/assign
评论为拉取请求分配审阅者对拉取请求提供非约束性审查
使用自动化来分类和分类问题
记录新功能
成为成员
在提交至少 5 个实质性拉取请求并满足其他 要求 后
在 #sig-docs Slack 通道 或 SIG Docs 邮件列表 中请求赞助。
注意
不要向单个 SIG Docs 成员发送直接电子邮件或 Slack 私信。您必须在提交申请之前请求赞助。在
kubernetes/org
存储库中打开 GitHub 问题。使用“组织成员资格请求”问题模板。让您的赞助者了解 GitHub 问题。您可以
在问题中提及他们的 GitHub 用户名(
@<GitHub-username>
)使用 Slack 或电子邮件将问题链接发送给他们。
赞助者将使用
+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 团队的成员。
批准者可以执行以下操作
如果 PR 已有 /lgtm
,或者批准者也使用 /lgtm
发表评论,则 PR 会自动合并。SIG Docs 批准者只应在不需要额外技术审查的更改上留下 /lgtm
。
批准拉取请求
批准者和 SIG Docs 负责人是唯一可以将拉取请求合并到网站存储库中的人员。这伴随着一定的责任。
批准者可以使用
/approve
命令,该命令会将 PR 合并到存储库中。警告
不小心合并可能会破坏网站,因此请确保您合并的内容是您想要的。确保建议的更改符合 文档内容指南。
如果您有任何疑问,或不确定某个事项,请随时寻求额外的审查。
在您
/approve
PR 之前,请验证 Netlify 测试是否通过。访问 PR 的 Netlify 页面预览,以确保在批准之前一切正常。
参与 PR 处理者轮班时间表 以进行每周轮班。SIG Docs 希望所有批准者都参与此轮班。有关更多详细信息,请参阅 PR 处理者。
成为批准者
当您满足 要求 时,您就可以成为 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 处理 的信息,这是所有批准者轮流承担的角色。