角色和职责
任何人都可以为 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 channel on 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 管理的信息,所有审批人都要轮流担任此角色。