CodisLabs/codis

Help wanted !!

Open

#1029 opened on Nov 10, 2016

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (12,459 stars) (2,681 forks)batch import
help wanted

Description

首先，感谢开源项目爱好者对 Codis 项目的关注和支持。

断断续续 2年时间，Codis 遗留的各种问题基本得到了解决。与 Codis2.0 仅仅重构 Proxy 内部实现不同，Codis3.0 & Codis3.1 整体的架构以及组件之间的通信方式都进行了彻底的修改，这也就导致之前的很多文档和测试都过时了。但是因为个人精力有限，很多事情做的都不是很好，比如：

  1. 缺少部署文档、使用文档、升级文档以及注意事项等等
  2. 却少详细的 Benchmark 以及 FAQ
  3. FE 实现的比较暴力，实现比较难看，

这里向广大 Codis 用户寻求帮助，寻求 PR，能协助我们尽快把项目完结。把更高质量的、更稳定的服务提供给更多的开源爱好者。

谢谢～

涉及到 3.1 的修改，可以看一下：#1009 #988 #979 #983

Contributor guide

Tech stack
goredis
Domain
documentationperformance
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programmingRedis knowledgeCodis architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue requests help with documentation (deployment, usage, upgrade), benchmarks, and FE improvements. Newcomers should review the referenced issues #1009, #988, #979, #983 to understand changes in Codis 3.1. Start by creating a basic deployment guide and then expand to other docs. The FE is built in Go (based on the repository) and may need refactoring. Benchmark scripts should measure proxy performance.