rosedblabs/rosedb

如何参与 rosedb ?

Closed this issue · 0 comments

熟悉 Pr 流程

  • 添加 test 方法
  • 添加 example 代码

目前 rosedb 当中的一些方法是没有对应的 Test 方法的,你可以按照已有的 Test,来为方法添加单元测测试。rosedb 下有一个 examples 目录,向用户展示 rosedb 的使用方法,你可以往其中添加一个方法。

这类 Pr 没有太多的技巧可言,只是为了让你熟悉整个 Pr 的流程,并且能够对 rosedb 中的一些方法有所认识,对 rosedb 的数据读写流程有更进一步的理解。

简单问题

  • 为 rosedb 添加更多 redis 相关的命令
  • good first issue
  • 添加 redis 协议中的方法

rosedb 支持的命令目前大致是按照 redis 来添加的,我们做到能够支持 redis 大多数常用的命令即可,做之前要确认一下这个命令在 rosedb 当中是不存在的。

尽量选择 redis 一些常用的命令,不常用的可以暂时不支持。

如果一个 issue 被标识为了 good first issue,则说明这个 issue 也很适合新手参与,你可以按照自己的情况选择自己感兴趣或擅长的。

目前 rosedb 支持了 redis 协议,但是对应的方法并不完整,你可以为 rosedb 添加一个对应的 redis 协议的方法,具体做法是:

  • 找到 cmd/server.go 中的 supportedCommands 变量,这里是所有支持的命令及其对应的处理方法
  • 选择一个在 rosedb 当中已经实现了而在这里又没有的方法
  • supportedCommands 中增加这个方法的名称,并添加对应的处理方法

说明:redis 协议的方法的输出尽量和原生 redis 保持一致

bug 修改或功能完善/增强

  • bug
  • enhancement

如果有一些 bug 或者新的功能,或是对已有功能进行完善,这类 issue 会被标识为 bugenhancement,这类问题可能稍微复杂点,需要你对 rosedb 整体的流程更加熟悉。

最后

每个 issue 都标识了该问题的难易程度(easy、medium、hard),你可以根据自己对 rosedb 的了解程度,选择适合自己的,对于任何问题或者 issue,在做之前,或者做的过程当中有问题的话,都可以提出来和我交流。