Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

如何参与 Godis #146

Open
HDT3213 opened this issue Apr 2, 2023 · 0 comments
Open

如何参与 Godis #146

HDT3213 opened this issue Apr 2, 2023 · 0 comments

Comments

@HDT3213
Copy link
Owner

HDT3213 commented Apr 2, 2023

Pull Request 规范

godis 遵循通用的 Pull Request (PR) 流程:

  1. Fork 仓库到您自己的 Github 账户。
  2. 在您 Fork 出的副本上进行开发。
  3. 向 Godis 提出 Pull Request。

我们希望您的 PR 可以满足下面的要求:

  1. 请确保您的代码进行了 gofmt,并通过了 golint 的检测。
  2. 请确保您的代码可以通过自动测试。您只需要在本地启动 redis-server 监听 6379 端口,并运行 go test ./... 命令即可完成自动测试,但测试代码可能会修改 redis server 中的数据。
  3. 添加新功能时应提供相应的单元测试
  4. 请在提交前清除开发过程中产生的不需要保留的代码和注释。
  5. 请保持 git 时间线的整洁。一个 PR 中应只包含一个或数个 commit,请在提 PR 前 squash 掉开发过程中产生的、不需要保留的 commit。请确保 PR 中不含 merge 节点
  6. 在您的 commit 被合并后请先与上游进行同步再进行下一个功能的开发。 PR 中请不要包含已合并的提交

我们不会拒绝任何微小的改进,您可以放心提出这些 PR:

  1. 添加注释
  2. 修改拼写错误
  3. 添加新的测试用例
  4. 拆分过于复杂的函数或模块
  5. 添加 Redis 未支持但您觉得有需要命令

也请您不要提出下列类型的 PR:

  1. 进行无意义的修改,比如使用 switch 替换 if-else
  2. 引入没必要的第三方库

我可以做什么

  1. 您可以通过为 Godis 添加测试用例或新命令来熟悉代码和流程
  2. good first issue 表示这个 issue 很适合新手参与
  3. 您可以在 project 面板 查看我们的计划
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant