chore: add CLAUDE.md for Claude Code project context#251
chore: add CLAUDE.md for Claude Code project context#251AlexStocks merged 3 commits intoarana-db:feat/raftfrom
Conversation
Provide build commands, architecture overview, lint rules, PR title convention, command system guide, and testing instructions. Co-Authored-By: LEILEI <leilei20010628@gmail.com>
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
github-actions
bot
added
✏️ Feature
- Fix runtime architecture description: remove "separate tokio runtimes" claim, describe async message channel communication accurately - Fix executor description: "thread pool" → "tokio async task pool" - Remove misleading CF numeric indices from storage model - Add crate name examples for unit test command - Add complete Python integration test steps with server startup Co-Authored-By: LEILEI <leilei20010628@gmail.com>
CLAUDE.md
Outdated
|
|
||
| # Run | ||
| cargo run --bin kiwi # Run server (debug) | ||
| cargo run --release # Run server (release) |
There was a problem hiding this comment.
这条命令从仓库根目录跑不通。当前仓库是 virtual workspace，根上没有可执行 package，cargo run --release 会直接失败；如果是想启动服务器，至少要把 server/kiwi 目标写全，比如 cargo run -p server --bin kiwi --release，或者明确说明需要先切到 src/server。
…space Co-Authored-By: LEILEI <leilei20010628@gmail.com>
AlexStocks
left a comment
AlexStocks
left a comment
There was a problem hiding this comment.
Code Review: chore: add CLAUDE.md for Claude Code project context
评价
文档内容结构清晰，涵盖了项目概述、构建命令、架构设计和开发规范，对贡献者友好。
[P1] 规范级问题
1. 缺少 CI/CD 详细说明
文档提到 make lint 但未说明：
- CI 检查的具体触发条件
- 如何在本地运行完整的 CI 流程
- PR 合并前的检查清单
建议补充:
## CI/CD
- PR 必须通过所有 CI 检查才能合并
- CI 运行内容：license header check → fmt check → clippy → build → test
- 本地预检：`make lint && make test`2. 缺少 Issue 引用规范
文档未说明如何引用相关 Issue（如 Fixes #123 或 Related to #456）。
总体评价：文档质量良好，建议补充 CI/CD 详细说明后合并。
2 participants
Provide build commands, architecture overview, lint rules, PR title convention, command system guide, and testing instructions.