欢送来到OpenMLDB开源社区!
自2021年开源以来,OpenMLDB始终受到了宽广用户的关注和青眼,也有气味相投的小伙伴接连不断地退出到社区当中 ,独特推动了OpenMLDB的提高和成长。
作为国内首个开源机器学习数据库,咱们以提供企业级 FeatureOps 全栈解决方案为己任,并且始终保持对社区开发者的期待与欢送。如需简略理解OpenMLDB,能够点击这里查看文档,或者点击这里查看视频。
欣慰于和老朋友交换碰撞、砥砺前行的同时,咱们也心愿能意识更多的新敌人,拓宽更多新思路。对此,OpenMLDB社区欢送大家通过以下形式对我的项目进行奉献:
- 标准和改良文档
- 翻译文档
- 测试项目
- 奉献代码,优化我的项目
为了激励更多气味相投的小伙伴更好地参加到OpenMLDB的奉献当中,咱们为大家整顿了这篇老手指南,心愿可能指引更多小伙伴顺利退出到社区贡献者的队伍当中!
如何成为OpenMLDB的Contributor?
理解OpenMLDB
首先,对于不太理解OpenMLDB的小伙伴,下方链接能够帮忙你失去初步的意识~
OpenMLDB GitHub:https://github.com/4paradigm/...
OpenMLDB 中武官网:https://openmldb.ai/
OpenMLDB 官网文档:https://openmldb.ai/docs/zh
后期筹备工作
接着,就能够开始后期筹备了!关上OpenMLDB的GitHub主页(https://github.com/4paradigm/...),点击右上角的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/...),查看issues列表。
如果你对我的项目有任何改良意见、性能需要、或者发现了某处bug,都欢送在GitHub Issues上提出!OpenMLDB社区期待你贵重的意见~
遇到感兴趣的issues,能够间接评论,发表认识或提出疑难。如果你违心帮忙解决这个issue,也欢送提出pr,帮忙独特优化OpenMLDB!
如果你不晓得从哪个issue下手,不如关上Issues页面置顶的贡献者挑战(https://github.com/4paradigm/...),或者抉择带有 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也十分期待更多小伙伴的独特参加,一起实现更高质量的我的项目文档!
提交完第一次pr并被merge之后,你就能在我的项目主页的Contributors里找到你本人了!如果乐意失去更多宣传曝光,后续咱们也将把你的信息展现到官网页面的贡献者名单中。
如何成为更踊跃的贡献者?
成为Contributors的一员后,如何更踊跃地投入社区,或是走上更高一级的台阶——升级成Active Contributor、Reviewer 乃至 Maintaier 呢?
还有更多能够做的,比方:
- 踊跃和社区成员交换,在GitHub Issues多多评论,为别人解疑答惑
- 奉献高质量的代码和文档
- 关注OpenMLDB的迭代和优化,及时体验新版本
当然,咱们也欢送大家退出OpenMLDB的微信交换群或Slack交换群,交换碰撞,激发灵感,互相帮助,互促成步,独特见证OpenMLDB的成长~