贡献

欢迎

欢迎来到 Volcano!

上手必读

代码管理

请务必关注和阅读我们的代码管理

社区要求

Volcano 是一个社区驱动的开源项目，致力于打造健康、友好和富有成效的环境。 社区的目标是开发 Volcano 系统，该系统有助于在 Kubernetes 上运行高性能的工作负载，如 AI、ML、深度学习应用程序。要建立这样一个系统，需要有共同目标的社 区贡献者的支持。

  • 请查看 社区角色 了解社区角色的具体情况。随着贡献度的提高，您的角色会逐渐升级。

开始

  • 查看安装文档 了解更多关于编译和部署的细节。

您的第一个贡献

我们将会帮助您在不同的领域做出贡献，如处理 issue、开发特性、修复关键 bug、检视您的代码并合入。

如果您对开发流程还有疑问，请查看Slack Channel( 注册点击这里)， 也可以加入我们的mailing list 。

寻找您感兴趣的领域开展工作

我们会一直需要您的帮助，如文档更新、上报 bug 或是编写代码。 试试寻找那些没有遵循最佳编码实践、需要代码重构或是缺少测试用例的地方吧。 下面的样例指导您如何开始。

寻找一个话题

在 Volcano 组织下有多个仓库。 每个仓库都有针对新人友好的第一个 issue 实践。 举个例子，Volcano-Issues 中具有 help wanted 和 good first issue 标签的 issue 一般不需要您对 Volcano 有非常多的了解即可开始工作。 我们会帮助新的贡献者针对这类 issue 开展工作。 另一个开始贡献的好办法是寻找一个待完善的文档，比如一个缺少超链接或超链接不可用的文档。请查看Contributing 下方的工作流程。

围绕一个 Issue 开展工作

当您有意愿针对某个 issue 开展工作时，您可以将这个 issue 分配给自己。在 issue 下回复/assign 或是 /assign @yourself即可。机器人将会把这个 issue 分配给您，您的昵称将会出现在被分配者列表中。

提交 Issue

我们不仅估计大家贡献代码，也非常欢迎大家提交 issue。 issue 需要被提交到 Volcano 的对应子仓库中。

举个例子：在 Volcano 中开启一个 issueVolcano 。

开启一个 issue 时，请遵循默认的提交指南。

贡献者工作流程

非常欢迎您提问题或是提交 pull request。

这里有一份贡献者工作流程的大纲供您参考：

  • 基于已有分支创建一个自定义分支，通常是基于 master 分支
  • 做一些修改后创建 commit
  • 请确保 commit 信息符合正确的格式
  • 将本地个人自定义分支的改动提交到远程个人库
  • 提交的 PR 必须得到至少 2 个社区维护者的 approval 才能合入

创建 Pull Requests

Pull requests 经常被简称为“PR”。 Volcano 遵循标准的github pull request 流程。

在上述流程中，volcano 机器人会对您的 PR 加入结构化标签。

Volcano 机器人也会给出一些有用的命令建议，这些命令将会在你的 PR 中运行以提示检视代码。 可以在注释中输入这些/command选项来触发自动标记和通知。

代码检视

为了使您的 PR 更容易的被检视，您需要做到以下几点：

  • 遵循好代码编写指南 。
  • 撰写合规的 commit messages
  • 将较大的修改分解成若干个逻辑独立的小的修改，这样会使得这些修改更容易被理解，统一起来可以解决一个较大的问题。
  • 给 PR 打上标签以关联到合适的检视人：阅读机器人发给你的指引你完成 PR 流程的提示信息有助于做到这一点。

commit 信息的格式

我们对提交消息遵循一个粗略的约定，旨在回答两个问题：做了哪些修改，为什么做这些修改。 主题中应该描述做了什么，commit 中应该描述为什么做这些。

  1. scripts: add test codes for metamanager
  3. this add some unit test codes to improve code coverage for metamanager
  5. Fixes #12

也可以采用以下更加正式的格式:

  1. <subsystem>: <what changed>
  2. <BLANK LINE>
  3. <why this change was made>
  4. <BLANK LINE>
  5. <footer>

第一行是主题并且不多于 70 个字符，第二行通常是空白行，其他行一般不超过 80 个字符。这样会使得 commit 信息在 github 上更容易被阅读。

请注意：如果您的 pull request 没有获得足够的关注，您可以通过 Slack 寻找检视人。

测试

这里有多种测试类型。 测试代码的位置因类型而异，成功运行测试所需的环境细节也会有所不同：

  • 单元测试：用于确认某个特定函数的行为是否符合预期。单元测试源代码可以在给定包中的对应源代码附近找到。任何开发人员都可以轻松地在本地运行这些程序。
  • 集成测试：这些测试包括包组件的交互，或者 Volcano 组件和 Kubernetes 控制平面组件（如 API 服务器）之间的交互。
  • 端到端测试(“e2e”)：宏观层面的系统一致性测试。Volcano e2e 测试用例位于：Volcano e2e。

当 PR 提交时会始终运行这些测试用例。