贡献者指南
如何成为 minikube 贡献者
行为准则
请善待彼此。请参阅我们的 Kubernetes 社区行为准则。
许可协议
我们很乐意接受您的补丁!在我们接受之前,请填写个人或公司贡献者许可协议 (CLA)
寻找可以处理的 issue
-
“good first issue” - 易于解决的问题
-
“help wanted” - 我们已确定需求但暂时没有资源去处理的问题
-
“priority/important-soon” 或 “priority/important-longterm” - 在未来几个版本中需要解决的关键问题。
-
如果不确定,请在 #minikube Slack 频道询问
一旦您发现要处理的问题
- 请在 issue 下添加评论,说明您计划处理该 issue
- 发送一个提及该 issue 的 PR
- 在 issue 上评论
/assign来将 issue 分配给自己
克隆 minikube
在 fork minikube 后,为了最佳实践,请按照以下说明进行 clone
git clone git@github.com:kubernetes/minikube.git
cd minikube
git remote rename origin upstream
git remote set-url --push upstream NO_PUSH
git remote add origin git@github.com:<YOUR_GITHUB_USERNAME>/minikube.git
贡献补丁
- 提交一个 issue 来描述您建议的变更
- 审阅者会及时回复您的 issue。
- 如果您的提议被接受,并且您尚未完成,请签署 贡献者许可协议 (CLA)
- Fork minikube 仓库,进行代码开发和测试。
- 在测试之前,您可能需要安装一些 先决条件。
- 提交一个 pull request。
贡献较大变更
要获得对更大、更具雄心的变更的反馈,请使用 MEP (minikube enhancement proposal) 模板 创建一个包含您想法的 PR。这样其他贡献者就可以及早评论设计问题,同时您也可以并行进行代码工作。
如果您在没有 MEP 的情况下发送了大型变更,请准备好接受其他贡献者要求您在 PR 中包含 MEP。
风格指南
对于编码,请参考 Kubernetes 编码约定
对于文档,请参考 Kubernetes 文档风格指南