入门
欢迎!👋
本指南介绍如何开始为 kind 做贡献 😄
内容 🔗︎
1. 熟悉为 Kubernetes 项目做贡献 🔗︎
阅读 Kubernetes 社区指南 🔗︎
请务必阅读 Kubernetes 社区指南。特别是,请阅读 Kubernetes 贡献者指南。
此外,请注意
设置 GitHub 帐户 🔗︎
Kubernetes 和 kind 在 GitHub 上开发,需要帐户才能进行贡献。
签署 CNCF CLA 🔗︎
Kubernetes 项目要求您针对所有子项目的所有贡献签署 CNCF CLA,并将其与您的 GitHub 帐户关联。
您需要签署 CLA 才能进行贡献。
查看 Kubernetes 贡献者指南 🔗︎
您可能稍后会回到这里,但我们强烈建议您阅读以下内容
- Kubernetes 贡献者指南
- 主要的贡献者文档,或者您也可以直接跳转到 贡献部分
- 贡献者备忘单
- 现有开发人员的常见资源
2. 安装工具 🔗︎
安装 Git 🔗︎
我们的源代码使用 git
管理,您需要安装 git
才能在本地进行开发。
您可以使用以下命令检查您的系统中是否已安装 git
以及是否已正确安装
git --version
安装 Docker 🔗︎
目前,要创建集群,您需要安装 Docker。
如果您尚未安装,请按照 官方说明 安装 Docker。如果您已经安装了,请检查您的版本并确保您拥有最新的 Docker。
要检查是否已安装 docker
docker --version
本文档使用 Docker 版本 18.09.2 编写。
安装 Go(可选) 🔗︎
KIND 使用 Go 编写,但我们的 makefile 会在构建或测试时自动确保使用正确的 Go 版本。
您可能仍然希望在您的机器上安装 Go,以便更轻松地将其集成到您的编辑器等中。您可以在 kind 存储库中的 .go-version
文件中找到我们当前用于开发 kind 的 Go 版本。
按照您的操作系统的说明安装或升级 Go。您可以使用以下命令检查您的系统中是否已安装 Go
3. 阅读文档 🔗︎
在进行贡献之前,您可能需要查看 设计原则、1.0 路线图 和 初始设计。这些文档介绍了一些项目理念和方向。
4. 联系我们 🔗︎
问题在 GitHub 上进行跟踪。请查看 问题跟踪器,看看是否有与您感兴趣的内容相关的现有讨论或工作。
特别是,如果您刚开始,您可能需要查看标记为 good first issue 或 help wanted 的问题,这些是 Kubernetes 项目中的标准标签。 help wanted 标签标记了我们正在积极寻求帮助的问题,而 good first issue 则额外应用于我们认为对新手特别有益的问题子集。
如果您有兴趣参与其中,请留言告知我们!
如果您没有看到任何内容,请 提交新问题。
注意:请在提交 PR 之前(最好是在编写任何代码之前)提交一个增强功能 / 功能请求问题 来讨论功能,在接受任何新功能时,我们有很多因素需要考虑,包括我们现有的用户和未来的支持。
为了简化流程,请尽快联系我们并讨论概念和设计/方法,以便维护人员和社区能够尽早参与。
此外,请随时就错误、功能请求和其他问题与我们联系!
本项目的维护人员可以通过以下方式联系:
- Kubernetes Slack 中的 #kind 频道(最活跃的频道,以及社区)
- 通过 提交问题 来联系问题跟踪器
- Kubernetes SIG-Testing 邮件列表
当前的维护人员是 @aojea 和 @BenTheElder - 如果您有任何问题,请随时直接联系他们!
另请参阅:Kubernetes 社区页面。
5. 下一步 🔗︎
好的,您已经设置了开发环境,阅读了所有贡献者指南,签署了 CLA … 现在呢?
如果您计划贡献代码更改,您需要阅读 开发指南。
如果您想贡献文档改进,首先:感谢您!🎉🤗 您需要查看开发指南中的 文档部分。