How to contribute?

[roseduan]

简体中文

Familiar with Pull Request

• add Test Case
• add example code

There are no Test methods for some API in rosedb, you can add test cases according to the existed.

And you can also add some example code to show users how to use rosedb(under examples dir). https://github.com/flower-corp/rosedb/tree/main/examples

This kind PRs only aims to let you deep into rosedb and understand more about how it works.

Easy problems

• add more Redis commands
• good first issue
• add Redis command

The commands in rosedb are most similar to Redis, our goal is to support the most frequently used commands in Redis, and make sure the command does not exist in rosedb before you add it.

Redis commands docs: https://redis.io/commands

If an issue is marked with good first issue, it is suitable for newcomers, you can pick one which you are interested in or good at.

Now rosedb has supported Redis protocol, but some commands are missed, so you can add the command:

• find variable supportedCommands in cmd/cli.go, which lists all supported commands and its handler function
• find a method in rosedb not listed here
• add the command and its handler function

Fix bugs or add/enhance features

If an issue is marked with bug or enhancement, which means bug fix or add/enhance features, you might have to understand completely rosedb to solve it.

Note

every issue is marked with its difficulty(easy, medium, hard), you can pick them according to your understanding of rosedb, and if you have any problems, contact me as soon.