mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-10 03:13:29 +08:00
docs(zh-CN): sync Chinese docs with latest upstream changes (#202)
* docs(zh-CN): sync Chinese docs with latest upstream changes * docs: improve Chinese translation consistency in go-test.md * docs(zh-CN): update image paths to use shared assets directory - Update image references from ./assets/ to ../../assets/ - Remove zh-CN/assets directory to use shared assets --------- Co-authored-by: neo <neo.dowithless@gmail.com>
This commit is contained in:
52
docs/zh-CN/rules/common/agents.md
Normal file
52
docs/zh-CN/rules/common/agents.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# 智能体编排
|
||||
|
||||
## 可用智能体
|
||||
|
||||
位于 `~/.claude/agents/` 中:
|
||||
|
||||
| 智能体 | 用途 | 使用时机 |
|
||||
|-------|---------|-------------|
|
||||
| planner | 实现规划 | 复杂功能、重构 |
|
||||
| architect | 系统设计 | 架构决策 |
|
||||
| tdd-guide | 测试驱动开发 | 新功能、错误修复 |
|
||||
| code-reviewer | 代码审查 | 编写代码后 |
|
||||
| security-reviewer | 安全分析 | 提交前 |
|
||||
| build-error-resolver | 修复构建错误 | 构建失败时 |
|
||||
| e2e-runner | 端到端测试 | 关键用户流程 |
|
||||
| refactor-cleaner | 清理死代码 | 代码维护 |
|
||||
| doc-updater | 文档 | 更新文档时 |
|
||||
|
||||
## 即时智能体使用
|
||||
|
||||
无需用户提示:
|
||||
|
||||
1. 复杂的功能请求 - 使用 **planner** 智能体
|
||||
2. 刚编写/修改的代码 - 使用 **code-reviewer** 智能体
|
||||
3. 错误修复或新功能 - 使用 **tdd-guide** 智能体
|
||||
4. 架构决策 - 使用 **architect** 智能体
|
||||
|
||||
## 并行任务执行
|
||||
|
||||
对于独立操作,**始终**使用并行任务执行:
|
||||
|
||||
```markdown
|
||||
# 良好:并行执行
|
||||
同时启动 3 个智能体:
|
||||
1. 智能体 1:认证模块的安全分析
|
||||
2. 智能体 2:缓存系统的性能审查
|
||||
3. 智能体 3:工具类的类型检查
|
||||
|
||||
# 不良:不必要的顺序执行
|
||||
先智能体 1,然后智能体 2,最后智能体 3
|
||||
|
||||
```
|
||||
|
||||
## 多视角分析
|
||||
|
||||
对于复杂问题,使用拆分角色的子智能体:
|
||||
|
||||
* 事实审查员
|
||||
* 高级工程师
|
||||
* 安全专家
|
||||
* 一致性审查员
|
||||
* 冗余检查器
|
||||
52
docs/zh-CN/rules/common/coding-style.md
Normal file
52
docs/zh-CN/rules/common/coding-style.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# 编码风格
|
||||
|
||||
## 不可变性(关键)
|
||||
|
||||
始终创建新对象,绝不改变现有对象:
|
||||
|
||||
```
|
||||
// Pseudocode
|
||||
WRONG: modify(original, field, value) → changes original in-place
|
||||
CORRECT: update(original, field, value) → returns new copy with change
|
||||
```
|
||||
|
||||
理由:不可变数据可以防止隐藏的副作用,使调试更容易,并支持安全的并发。
|
||||
|
||||
## 文件组织
|
||||
|
||||
多个小文件 > 少数大文件:
|
||||
|
||||
* 高内聚,低耦合
|
||||
* 通常 200-400 行,最多 800 行
|
||||
* 从大型模块中提取实用工具
|
||||
* 按功能/领域组织,而不是按类型组织
|
||||
|
||||
## 错误处理
|
||||
|
||||
始终全面处理错误:
|
||||
|
||||
* 在每个层级明确处理错误
|
||||
* 在面向用户的代码中提供用户友好的错误消息
|
||||
* 在服务器端记录详细的错误上下文
|
||||
* 绝不默默地忽略错误
|
||||
|
||||
## 输入验证
|
||||
|
||||
始终在系统边界处进行验证:
|
||||
|
||||
* 在处理前验证所有用户输入
|
||||
* 在可用时使用基于模式的验证
|
||||
* 快速失败并提供清晰的错误消息
|
||||
* 绝不信任外部数据(API 响应、用户输入、文件内容)
|
||||
|
||||
## 代码质量检查清单
|
||||
|
||||
在标记工作完成之前:
|
||||
|
||||
* \[ ] 代码可读且命名良好
|
||||
* \[ ] 函数短小(<50 行)
|
||||
* \[ ] 文件专注(<800 行)
|
||||
* \[ ] 没有深度嵌套(>4 层)
|
||||
* \[ ] 正确的错误处理
|
||||
* \[ ] 没有硬编码的值(使用常量或配置)
|
||||
* \[ ] 没有突变(使用不可变模式)
|
||||
46
docs/zh-CN/rules/common/git-workflow.md
Normal file
46
docs/zh-CN/rules/common/git-workflow.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# Git 工作流程
|
||||
|
||||
## 提交信息格式
|
||||
|
||||
```
|
||||
<type>: <description>
|
||||
|
||||
<optional body>
|
||||
```
|
||||
|
||||
类型:feat, fix, refactor, docs, test, chore, perf, ci
|
||||
|
||||
注意:通过 ~/.claude/settings.json 全局禁用了归因。
|
||||
|
||||
## 拉取请求工作流程
|
||||
|
||||
创建 PR 时:
|
||||
|
||||
1. 分析完整的提交历史(不仅仅是最近一次提交)
|
||||
2. 使用 `git diff [base-branch]...HEAD` 查看所有更改
|
||||
3. 起草全面的 PR 摘要
|
||||
4. 包含带有 TODO 的测试计划
|
||||
5. 如果是新分支,使用 `-u` 标志推送
|
||||
|
||||
## 功能实现工作流程
|
||||
|
||||
1. **先做计划**
|
||||
* 使用 **planner** 代理创建实施计划
|
||||
* 识别依赖项和风险
|
||||
* 分解为多个阶段
|
||||
|
||||
2. **TDD 方法**
|
||||
* 使用 **tdd-guide** 代理
|
||||
* 先写测试(RED)
|
||||
* 实现代码以通过测试(GREEN)
|
||||
* 重构(IMPROVE)
|
||||
* 验证 80%+ 的覆盖率
|
||||
|
||||
3. **代码审查**
|
||||
* 编写代码后立即使用 **code-reviewer** 代理
|
||||
* 解决 CRITICAL 和 HIGH 级别的问题
|
||||
* 尽可能修复 MEDIUM 级别的问题
|
||||
|
||||
4. **提交与推送**
|
||||
* 详细的提交信息
|
||||
* 遵循约定式提交格式
|
||||
33
docs/zh-CN/rules/common/hooks.md
Normal file
33
docs/zh-CN/rules/common/hooks.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# Hooks 系统
|
||||
|
||||
## Hook 类型
|
||||
|
||||
* **PreToolUse**:工具执行前(验证、参数修改)
|
||||
* **PostToolUse**:工具执行后(自动格式化、检查)
|
||||
* **Stop**:会话结束时(最终验证)
|
||||
|
||||
## 自动接受权限
|
||||
|
||||
谨慎使用:
|
||||
|
||||
* 为受信任、定义明确的计划启用
|
||||
* 为探索性工作禁用
|
||||
* 切勿使用 dangerously-skip-permissions 标志
|
||||
* 改为在 `~/.claude.json` 中配置 `allowedTools`
|
||||
|
||||
## TodoWrite 最佳实践
|
||||
|
||||
使用 TodoWrite 工具来:
|
||||
|
||||
* 跟踪多步骤任务的进度
|
||||
* 验证对指令的理解
|
||||
* 实现实时指导
|
||||
* 展示详细的实现步骤
|
||||
|
||||
待办事项列表可揭示:
|
||||
|
||||
* 步骤顺序错误
|
||||
* 缺失的项目
|
||||
* 额外不必要的项目
|
||||
* 粒度错误
|
||||
* 对需求的理解有误
|
||||
34
docs/zh-CN/rules/common/patterns.md
Normal file
34
docs/zh-CN/rules/common/patterns.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# 常见模式
|
||||
|
||||
## 骨架项目
|
||||
|
||||
当实现新功能时:
|
||||
|
||||
1. 搜索经过实战检验的骨架项目
|
||||
2. 使用并行代理评估选项:
|
||||
* 安全性评估
|
||||
* 可扩展性分析
|
||||
* 相关性评分
|
||||
* 实施规划
|
||||
3. 克隆最佳匹配作为基础
|
||||
4. 在已验证的结构内迭代
|
||||
|
||||
## 设计模式
|
||||
|
||||
### 仓库模式
|
||||
|
||||
将数据访问封装在一个一致的接口之后:
|
||||
|
||||
* 定义标准操作:findAll, findById, create, update, delete
|
||||
* 具体实现处理存储细节(数据库、API、文件等)
|
||||
* 业务逻辑依赖于抽象接口,而非存储机制
|
||||
* 便于轻松切换数据源,并使用模拟对象简化测试
|
||||
|
||||
### API 响应格式
|
||||
|
||||
对所有 API 响应使用一致的信封格式:
|
||||
|
||||
* 包含一个成功/状态指示器
|
||||
* 包含数据载荷(出错时可为空)
|
||||
* 包含一个错误消息字段(成功时可为空)
|
||||
* 为分页响应包含元数据(总数、页码、限制)
|
||||
63
docs/zh-CN/rules/common/performance.md
Normal file
63
docs/zh-CN/rules/common/performance.md
Normal file
@@ -0,0 +1,63 @@
|
||||
# 性能优化
|
||||
|
||||
## 模型选择策略
|
||||
|
||||
**Haiku 4.5** (具备 Sonnet 90% 的能力,节省 3 倍成本):
|
||||
|
||||
* 频繁调用的轻量级智能体
|
||||
* 结对编程和代码生成
|
||||
* 多智能体系统中的工作智能体
|
||||
|
||||
**Sonnet 4.5** (最佳编码模型):
|
||||
|
||||
* 主要的开发工作
|
||||
* 编排多智能体工作流
|
||||
* 复杂的编码任务
|
||||
|
||||
**Opus 4.5** (最深的推理能力):
|
||||
|
||||
* 复杂的架构决策
|
||||
* 最高级别的推理需求
|
||||
* 研究和分析任务
|
||||
|
||||
## 上下文窗口管理
|
||||
|
||||
避免使用上下文窗口的最后 20% 进行:
|
||||
|
||||
* 大规模重构
|
||||
* 跨多个文件的功能实现
|
||||
* 调试复杂的交互
|
||||
|
||||
上下文敏感性较低的任务:
|
||||
|
||||
* 单文件编辑
|
||||
* 创建独立的实用工具
|
||||
* 文档更新
|
||||
* 简单的错误修复
|
||||
|
||||
## 扩展思考 + 计划模式
|
||||
|
||||
扩展思考默认启用,最多保留 31,999 个令牌用于内部推理。
|
||||
|
||||
通过以下方式控制扩展思考:
|
||||
|
||||
* **切换**:Option+T (macOS) / Alt+T (Windows/Linux)
|
||||
* **配置**:在 `~/.claude/settings.json` 中设置 `alwaysThinkingEnabled`
|
||||
* **预算上限**:`export MAX_THINKING_TOKENS=10000`
|
||||
* **详细模式**:Ctrl+O 查看思考输出
|
||||
|
||||
对于需要深度推理的复杂任务:
|
||||
|
||||
1. 确保扩展思考已启用(默认开启)
|
||||
2. 启用 **计划模式** 以获得结构化方法
|
||||
3. 使用多轮批判进行彻底分析
|
||||
4. 使用分割角色子代理以获得多元视角
|
||||
|
||||
## 构建故障排除
|
||||
|
||||
如果构建失败:
|
||||
|
||||
1. 使用 **build-error-resolver** 智能体
|
||||
2. 分析错误信息
|
||||
3. 逐步修复
|
||||
4. 每次修复后进行验证
|
||||
31
docs/zh-CN/rules/common/security.md
Normal file
31
docs/zh-CN/rules/common/security.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# 安全指南
|
||||
|
||||
## 强制性安全检查
|
||||
|
||||
在**任何**提交之前:
|
||||
|
||||
* \[ ] 没有硬编码的密钥(API 密钥、密码、令牌)
|
||||
* \[ ] 所有用户输入都经过验证
|
||||
* \[ ] 防止 SQL 注入(使用参数化查询)
|
||||
* \[ ] 防止 XSS(净化 HTML)
|
||||
* \[ ] 已启用 CSRF 保护
|
||||
* \[ ] 已验证身份验证/授权
|
||||
* \[ ] 所有端点都实施速率限制
|
||||
* \[ ] 错误信息不泄露敏感数据
|
||||
|
||||
## 密钥管理
|
||||
|
||||
* 切勿在源代码中硬编码密钥
|
||||
* 始终使用环境变量或密钥管理器
|
||||
* 在启动时验证所需的密钥是否存在
|
||||
* 轮换任何可能已泄露的密钥
|
||||
|
||||
## 安全响应协议
|
||||
|
||||
如果发现安全问题:
|
||||
|
||||
1. 立即**停止**
|
||||
2. 使用 **security-reviewer** 代理
|
||||
3. 在继续之前修复**关键**问题
|
||||
4. 轮换任何已暴露的密钥
|
||||
5. 审查整个代码库是否存在类似问题
|
||||
31
docs/zh-CN/rules/common/testing.md
Normal file
31
docs/zh-CN/rules/common/testing.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# 测试要求
|
||||
|
||||
## 最低测试覆盖率:80%
|
||||
|
||||
测试类型(全部需要):
|
||||
|
||||
1. **单元测试** - 单个函数、工具、组件
|
||||
2. **集成测试** - API 端点、数据库操作
|
||||
3. **端到端测试** - 关键用户流程(根据语言选择框架)
|
||||
|
||||
## 测试驱动开发
|
||||
|
||||
强制工作流程:
|
||||
|
||||
1. 先写测试 (失败)
|
||||
2. 运行测试 - 它应该失败
|
||||
3. 编写最小实现 (成功)
|
||||
4. 运行测试 - 它应该通过
|
||||
5. 重构 (改进)
|
||||
6. 验证覆盖率 (80%+)
|
||||
|
||||
## 测试失败排查
|
||||
|
||||
1. 使用 **tdd-guide** 代理
|
||||
2. 检查测试隔离性
|
||||
3. 验证模拟是否正确
|
||||
4. 修复实现,而不是测试(除非测试有误)
|
||||
|
||||
## 代理支持
|
||||
|
||||
* **tdd-guide** - 主动用于新功能,强制执行测试优先
|
||||
Reference in New Issue
Block a user