成为 Milvus 贡献者

不知道如何快速地成为 Milvus 贡献者?请看这篇文档!

如果还没有 GitHub 账号,先注册一个。

找到可以做的内容

第一步,找到可以改进的地方。Milvus 社区欢迎各种形式的贡献,再小的贡献都是好的!

这里有一些事情不需要你有很强的技术背景,可以作为你贡献的开始:

  • 帮助改进 Milvus 的文档
  • 给代码加些注释
  • 写一个单元测试

另外,还可以在设置了 good-first-issue 标签的 Issue 中找到你感兴趣的。good-first-issue 标签下的 Issue 都包含明确的步骤和预期产出,适合第一次做贡献的开发者。

在 GitHub 上将 Issue 分配给自己

第二步,当你找到了一个合适的 Issue,你需要将 Issue 分配给你自己,让他人知道你打算解决这个 Issue。

  • 在 Issue 下回复 /assign @yourself(yourself 换成你的 GitHub 用户名)
  • 机器人会自动地将这个 Issue 分配给你
  • 你的名字将会出现在 Assignees

解决这个 Issue,并且提交一个 Pull Request

第三步,你需要把项目下载到本地进行修改,然后提交给 Milvus 项目。这一步需要你本地装有 Git,以及一点命令行的使用经验。

如果还没有安装 Git,请看这里

Fork 仓库

在 Milvus 仓库的页面上,点击右上角的Fork按钮。这会在你的账户中创建一个这个仓库的副本。

image-20210618153043823

Clone 仓库

在你的账户中找到这个仓库的副本,点击 Code 按钮,在弹出的页面点击 复制到剪贴板 按键。

image-20210618153215652

打开终端并运行以下命令:

$ git clone <剪贴板内容>

例如:

$ git clone https://github.com/yourself/milvus.git

这时,一个名为 milvus 的仓库会下载到你的电脑上。

创建分支

进入到代码仓库的目录:

$ cd milvus

现在,使用 git checkout 命令创建一个分支:

$ git checkout -b <your-new-branch-name>

<your-new-branch-name> 换成你的分支名(分支名最好能够表示你要做什么事情)。

修改和提交

现在,开始你的修改,在修改完之后记得保存文件。

如果第一次使用 Git,需要先配置自己的名字和邮箱,提交内容时 Git 会将这两个字段作为作者的信息

$ git config --global user.name "John Doe"
$ git config --global user.email johndoe@example.com

使用 git add 命令选中刚才修改的文件:

$ git add <filename>

需要将 <filename> 替换成刚才修改的文件。

然后,使用 git commit 提交选中的文件:

$ git commit -m "<commit-message>" -s

<commit-message> 改为这次修改内容的简述。

将修改上传到 GitHub

现在,需要使用 git push 命令将本地的改动上传到 GitHub:

$ git push origin <your-branch-name>

<your-branch-name> 替换成上面创建的分支名。

将改动提交到 Milvus 仓库

回到 GitHub 上自己的仓库页面,会看到一个提示,点击 Compare & pull request 创建 Pull Request,然后等待 review 和合并。

image-20210618154611749

改进这篇文档

如果你在这篇文档中遇到了问题,也可以在 GitHub 上修改它




© Milvus 2021Milvus, and associated open source project names are trademarks of the LF AI & Data Foundation