贡献指南，带你启航：如何给OpenMLDB社区贡献代码

新手指南，带你启航：如何给OpenMLDB社区贡献代码

欢迎来到OpenMLDB开源社区！

自2021年开源以来，OpenMLDB一直受到了广大用户的关注和青睐，也有志同道合的小伙伴接连不断地加入到社区当中 ，共同推动了OpenMLDB的进步和成长。

作为国内首个开源机器学习数据库，我们以提供企业级 FeatureOps 全栈解决方案为己任，并且始终保持对社区开发者的期待与欢迎。如需简单了解OpenMLDB，可以点击这里查看文档，或者点击这里查看视频。

欣喜于和老朋友交流碰撞、砥砺前行的同时，我们也希望能认识更多的新朋友，拓宽更多新思路。对此，OpenMLDB社区欢迎大家通过以下方式对项目进行贡献：

• 规范和改进文档
• 翻译文档
• 测试项目
• 贡献代码，优化项目

为了激励更多志同道合的小伙伴更好地参与到OpenMLDB的贡献当中，我们为大家整理了这篇新手指南，希望能够指引更多小伙伴顺利加入到社区贡献者的队伍当中！

如何成为OpenMLDB的Contributor？

了解OpenMLDB

首先，对于不太了解OpenMLDB的小伙伴，下方链接可以帮助你得到初步的认识~

OpenMLDB GitHub：https://github.com/4paradigm/OpenMLDB

OpenMLDB 中文官网：https://openmldb.ai/

OpenMLDB 官方文档：https://openmldb.ai/docs/zh

前期准备工作

接着，就可以开始前期准备了！打开OpenMLDB的GitHub主页（https://github.com/4paradigm/OpenMLDB），点击右上角的Fork按钮，将项目仓库归入自己的私人仓库。

​

然后在私人仓库中找到刚刚Fork的OpenMLDB镜像，点击code按钮，复制url。

​

继续行动，在本地找到想要clone代码的文件夹，右键选择Git Bash，将OpenMLDB仓库clone到本地：

git clone https://github.com/${your-github-id}/OpenMLDB.git

前期准备工作完成！

提交Issue/解决Issue

第一步，点开OpenMLDB的GitHub Issues（https://github.com/4paradigm/OpenMLDB/issues），查看issues列表。

如果你对项目有任何改进意见、功能需求、或者发现了某处bug，都欢迎在GitHub Issues上提出！OpenMLDB社区期待你宝贵的意见~

遇到感兴趣的issues，可以直接评论，发表看法或提出疑问。如果你愿意帮忙解决这个issue，也欢迎提出pr，帮助共同优化OpenMLDB！

如果你不知道从哪个issue下手，不如打开Issues页面置顶的贡献者挑战（https://github.com/4paradigm/OpenMLDB/issues/1344），或者选择带有 good-first-issue 标签的任务（Issues · 4paradigm/OpenMLDB · GitHub），这都是社区特地为新朋友准备的任务，帮助大家快速低门槛完成第一次的贡献！（同时，我们每一次的贡献者任务都有小礼品赠送哦！）

​

代码贡献

如果你已经准备好向OpenMLDB贡献代码了，欢迎提交pr！接下来，我们将详细介绍贡献代码的过程。

打开我们刚刚clone到本地的仓库，做出你想进行的改动。如果你在修改代码或文档时遇到了任何问题，也可以在我们的微信交流群和slack交流群中提出（点击链接进入网页，最下方有交流群进群渠道），和其他社区成员进行讨论。

提交pr最佳方式是新建一个分支用于提交你的改动，比如，你可以输入以下命令新建分支并切换：

git checkoout -b  your_branch 

再输入以下命令检查你做的改动：

git status

如果改动没有问题，输入指令，将文件添加到暂存区：

git add .

将改动的内容commit到仓库：

git commit -m "commit message"

此时，返回OpenMLDB的仓库主页，点击“compare and pull request”的按钮，请求 merge 你的分支（your_branch）到 main 分支。此时，填写相关信息，就可以向OpenMLDB项目做出贡献啦！

这样，你就成为了Contributors的一员啦！OpenMLDB社区非常期待你的pr哟！

文档优化 文档翻译

项目文档是开源社区中不可忽视的内容，它既是帮助社区开发者快速地了解项目的说明书，也是非常重要的项目管理工具。所以文档优化也是我们期待得到协助的重点工作之一。同时，作为面向世界开发者的开源项目，为了让来自全球社区成员了解OpenMLDB，文档的翻译工作也需要你的帮助！

在docs文件夹（https://github.com/4paradigm/OpenMLDB/tree/main/docs）下，可以轻松看到项目的中英双语文档，正静静地等待着优化和翻译。优化翻译过后，文档的提交过程与代码提交过程一致。OpenMLDB也非常期待更多小伙伴的共同参与，一起完成更高质量的项目文档！

提交完第一次pr并被merge之后，你就能在项目主页的Contributors里找到你自己了！如果乐意得到更多宣传曝光，后续我们也将把你的信息展示到官网页面的贡献者名单中。

如何成为更积极的贡献者？

成为Contributors的一员后，如何更积极地投入社区，或是走上更高一级的台阶——升级成Active Contributor、Reviewer 乃至 Maintaier 呢？

还有更多可以做的，比如：

• 积极和社区成员交流，在GitHub Issues多多评论，为他人解疑答惑
• 贡献高质量的代码和文档
• 关注OpenMLDB的迭代和优化，及时体验新版本

当然，我们也欢迎大家加入OpenMLDB的微信交流群或Slack交流群，交流碰撞，激发灵感，互相帮助，互促进步，共同见证OpenMLDB的成长~