自今年启动 OpenMLDB 贡献者计划后,我们陆陆续续收到了来自世界各地开发者的支持和鼓励,也在各位的帮助下见证了 OpenMLDB 一步步的迭代升级,一次次的成熟完善。
目前,OpenMLDB 已经进入了 0.6.4 的全新阶段,也收获了 120+ 的贡献者,还有广大的关注者和支持者。在我们合力解决 issue、共同推动 OpenMLDB 进步的过程中,还有一个问题不容忽视。那就是——Bug。
长期以来,或大或小的 bug 藏匿在 OpenMLDB 社区的角落里,阻扰着 OpenMLDB 产品的成长升级,也阻碍着 OpenMLDB 用户的使用体验。为了改进项目质量,今日 OpenMLDB 正式发布《BUG 悬赏令》,希望能:
汇天下英才,捉各处 Bug。
聚开源之力,助社区完善。
同时,我们也会为帮忙捉虫的各位开发者送上好礼!
如果你已经摩拳擦掌、跃跃欲试,那么往下翻阅,细细了解一下这份悬赏令吧。
(* OpenMLDB 社区保留活动最终解释权)
活动规则
悬赏时间
10月27日至12月31日,面向 OpenMLDB 的最新发布和开发版本
悬赏标准
Bug 会分为文档类和代码类,如果同时涉及到文档和代码,则归于代码类。
悬赏范围
OpenMLDB 中文文档:https://openmldb.ai/docs/zh/main/
OpenMLDB 英文文档:https://openmldb.ai/docs/en/main/
OpenMLDB 代码库:https://github.com/4paradigm/OpenMLDB/
参与方式
找到潜藏在 OpenMLDB 社区中的 bug 并提交 issue。
当然,如果在提交 bug 后,你愿意继续参与到 bugfix 中,我们也十分欢迎并且会参照 贡献者任务 的奖励规则会为你准备周边好礼。(贡献者任务的具体内容详见文末)
捕捉 bug 的推荐方向(必读!)
OpenMLDB 核心开发团队建议社区贡献者可以在以下方向进行寻找:
-
SQL 语法文档描述和产出结果正确性,主要对应的文档为:https://openmldb.ai/docs/zh/main/reference/sql/dql/index.html
-
Built-in 函数的描述和产出结果正确性,对应文档为:https://openmldb.ai/docs/zh/main/reference/sql/functions_and_operators/Files/udfs_8h.html
(注意,该文档通过代码自动生成,请勿直接修改该文档。如果希望更新,可以在文件 hybridse/src/udf/default_udf_library.cc 或者 hybridse/src/udf/default_defs/*_def.cc下查找到对应函数的注释说明,进行修改源文件提交 PR。我们会有一个天级别的任务定期更新网站内容)
对于这两个方向,我们建议大家可以注意以下几点:
- 注意同时测试离线模式和在线请求模式
- 注意同时测试单机版和分布式版本
- 多多测试 corner cases,可能是我们之前自动化测试用例所没有覆盖到的
- 特别的,我们也非常欢迎对于文档的改进,包括描述的准确性、专业性、易于理解性
另外,以上两个推荐的方向都可以很方便的运行我们的 docker 镜像即可测试,关于 docker 镜像的基本使用步骤可以参见我们的 QuickStart: https://openmldb.ai/docs/zh/main/quickstart/openmldb_quickstart.html
提交修复 bug 的正确姿势
提交 bug
发现 bug 以后,参照以下步骤提交 issue:
-
在 GitHub 中提交 issue 反馈你在使用中遇到的 bug。此处需要描述或复现步骤,记录错误日志以及相关配置,为社区追踪 bug 提供相关的线索
-
为该 issue 添加上 label "bug"
注意:
-
一个 issue 我们计算为一个 bug,所以尽量不要把多个 bug 放在同一个 issue 进行提交
-
建议使用英文进行 bug 提交和讨论
-
bug会由核心开发成员进行沟通和核实,如果并非真正bug(比如由于误操作、不支持的环境等引起的),则社区保留关闭issue的权利。
参与 bugfix
如果你想参与到 bugfix 中来:
- 通过 GitHub 上的带有标签 "bug" 的 issue 寻找已知 bug list,或者就针对你自己找到的 bug 的相应 issue
- 在相应的 issue 下面留言,表示你想解决该 issue,我们会尽快把该 issue 分配给你,避免不同贡献者重复劳动,如果你不确定某些 issue 是否已经被分配,你可以留言或者在我们的社区微信群(见文末)里寻求确认。
- 完成以后提交 PR,并且关联相关 issue(通过 close/fix/resolve 等关键字)
活动奖励
奖励一览
兑换规则
bug 数量 | 文档类 | 代码类 |
---|---|---|
=1 | 数据线、鼠标垫、IP公仔三选一 | 棒球帽、空调毯、T恤三选一 |
=2 | 数据线、鼠标垫、IP公仔三选二 | 棒球帽、空调毯、T恤三选二 |
=3 | 数据线、鼠标垫、IP公仔全带走 | 棒球帽、空调毯、T恤全带走 |
≥5 | 加赠OpenMLDBT恤 | 加赠OpenMLDB卫衣 |
≥10 | 加赠定制棒球帽 | 加赠蓝牙音箱 |
特别注意
由于物流限制,非中国地区的参与者无法获得实物奖品,但 OpenMLDB 社区会为您准备等价值的亚马逊购物卡。
兑换通道
请发送邮件至 contact@openmldb.ai,邮件命名为“姓名_GitHubID_捉虫”,正文为提出 bug 的 issue 地址(可能也有解决 bug 的 PR 地址)以及选择的奖励。我们会在收到邮件后尽快回复并安排上属于你的礼包~
贡献者任务活动
OpenMLDB BUG 悬赏令 正式开启,期待大家的踊跃参与!
有疑问可在社区交流群与我们取得联系~
社区联系渠道 ↓