How to contribute

[HDT3213]

简体中文

Pull Request Guidelines

Godis follows the common Pull Request (PR) process:

1. Fork the repository to your own Github account.
2. Develop on the forked copy.
3. Submit a Pull Request to Godis.

We hope that your PR meets the following requirements:

1. Please ensure that your code has been formatted by gofmt and passed golint checks.
2. Please ensure that your code passes unit tests. You only need to start redis server listening on port 6379 locally to complete the unit test, but the test code may modify the data in the Redis server.
3. When adding new features, please provide corresponding unit tests.
4. Please keep the Git timeline clean. A PR should only contain one or several commits. Please squash unneeded commits produced during development before submitting a PR. Ensure that the PR does not contain merge nodes.

We will not reject any minor improvements, so you can confidently submit these PRs:

1. Add comments
2. Correct spelling errors
3. Add new test cases
4. Split functions or modules that are too complex
5. Add Redis commands that are not currently supported but you think are useful

Please do not submit the following types of PRs:

1. Make meaningless changes, such as using switch instead of if-else.
2. Introduce unnecessary third-party libraries.

What Can I Do?

1. You can familiarize yourself with the code and process by adding test cases or new commands to Godis.
2. good first issue means that this issue is very suitable for beginners to participate in.
3. You can see our plan on the project board.