docs: 完成所有文档的中文翻译并应用到项目

This commit is contained in:
xuxiang
2026-01-28 00:12:54 +08:00
parent 0ced59a26b
commit e133f58e1c
76 changed files with 6808 additions and 6170 deletions

View File

@@ -1,58 +1,58 @@
# Example Project CLAUDE.md
# 项目示例 CLAUDE.md
This is an example project-level CLAUDE.md file. Place this in your project root.
这是一个项目级 CLAUDE.md 文件的示例。请将其放置在项目根目录下。
## Project Overview
## 项目概览
[Brief description of your project - what it does, tech stack]
[简要描述您的项目 - 功能、技术栈]
## Critical Rules
## 核心规则
### 1. Code Organization
### 1. 代码组织
- Many small files over few large files
- High cohesion, low coupling
- 200-400 lines typical, 800 max per file
- Organize by feature/domain, not by type
- 倾向于使用多个小文件,而非少数大文件
- 高内聚,低耦合
- 通常为 200-400 行,单文件最大不超过 800 行
- 按功能/领域Feature/Domain)组织,而非按类型组织
### 2. Code Style
### 2. 代码风格
- No emojis in code, comments, or documentation
- Immutability always - never mutate objects or arrays
- No console.log in production code
- Proper error handling with try/catch
- Input validation with Zod or similar
- 代码、注释或文档中不得使用表情符号Emoji
- 始终坚持不可变性(Immutability - 严禁直接修改对象或数组
- 生产代码中严禁使用 `console.log`
- 使用 try/catch 进行妥善的错误处理
- 使用 Zod 或类似工具进行输入验证
### 3. Testing
### 3. 测试
- TDD: Write tests first
- 80% minimum coverage
- Unit tests for utilities
- Integration tests for APIs
- E2E tests for critical flows
- 测试驱动开发TDD先写测试
- 最低 80% 的覆盖率
- 为工具函数编写单元测试
- 为 API 编写集成测试
- 为核心流程编写端到端E2E测试
### 4. Security
### 4. 安全
- No hardcoded secrets
- Environment variables for sensitive data
- Validate all user inputs
- Parameterized queries only
- CSRF protection enabled
- 严禁硬编码秘钥Secrets
- 敏感数据使用环境变量
- 验证所有用户输入
- 仅使用参数化查询(Parameterized queries
- 启用跨站请求伪造CSRF防护
## File Structure
## 文件结构
```
src/
|-- app/ # Next.js app router
|-- components/ # Reusable UI components
|-- hooks/ # Custom React hooks
|-- lib/ # Utility libraries
|-- types/ # TypeScript definitions
|-- app/ # Next.js 应用路由
|-- components/ # 可复用的 UI 组件
|-- hooks/ # 自定义 React hooks
|-- lib/ # 工具库
|-- types/ # TypeScript 定义
```
## Key Patterns
## 关键模式
### API Response Format
### API 响应格式
```typescript
interface ApiResponse<T> {
@@ -62,39 +62,39 @@ interface ApiResponse<T> {
}
```
### Error Handling
### 错误处理
```typescript
try {
const result = await operation()
return { success: true, data: result }
} catch (error) {
console.error('Operation failed:', error)
return { success: false, error: 'User-friendly message' }
console.error('操作失败:', error)
return { success: false, error: '用户友好提示信息' }
}
```
## Environment Variables
## 环境变量
```bash
# Required
# 必填
DATABASE_URL=
API_KEY=
# Optional
# 选填
DEBUG=false
```
## Available Commands
## 可用命令
- `/tdd` - Test-driven development workflow
- `/plan` - Create implementation plan
- `/code-review` - Review code quality
- `/build-fix` - Fix build errors
- `/tdd` - 测试驱动开发TDD工作流
- `/plan` - 创建实现方案
- `/code-review` - 代码质量评审
- `/build-fix` - 修复构建错误
## Git Workflow
## Git 工作流
- Conventional commits: `feat:`, `fix:`, `refactor:`, `docs:`, `test:`
- Never commit to main directly
- PRs require review
- All tests must pass before merge
- 约定式提交(Conventional commits`feat:`, `fix:`, `refactor:`, `docs:`, `test:`
- 严禁直接提交到 main 分支
- 合并请求PRs必须经过评审
- 所有测试必须通过后方可合并

View File

@@ -1,103 +1,103 @@
# User-Level CLAUDE.md Example
# 用户级 CLAUDE.md 示例
This is an example user-level CLAUDE.md file. Place at `~/.claude/CLAUDE.md`.
这是一个用户级 CLAUDE.md 文件示例。请放置在 `~/.claude/CLAUDE.md`
User-level configs apply globally across all projects. Use for:
- Personal coding preferences
- Universal rules you always want enforced
- Links to your modular rules
用户级配置全局适用于所有项目。用于:
- 个人编码偏好
- 你希望始终强制执行的通用规则
- 指向你的模块化规则的链接
---
## Core Philosophy
## 核心哲学(Core Philosophy
You are Claude Code. I use specialized agents and skills for complex tasks.
你是 Claude Code。我使用专门的智能体Agents和技能Skills处理复杂任务。
**Key Principles:**
1. **Agent-First**: Delegate to specialized agents for complex work
2. **Parallel Execution**: Use Task tool with multiple agents when possible
3. **Plan Before Execute**: Use Plan Mode for complex operations
4. **Test-Driven**: Write tests before implementation
5. **Security-First**: Never compromise on security
**核心原则:**
1. **智能体优先(Agent-First**:将复杂工作委托给专门的智能体
2. **并行执行(Parallel Execution**:尽可能使用 Task 工具配合多个智能体
3. **先计划后执行(Plan Before Execute**对复杂操作使用计划模式Plan Mode
4. **测试驱动(Test-Driven**:在实现前编写测试
5. **安全第一(Security-First**:绝不妥协安全性
---
## Modular Rules
## 模块化规则(Modular Rules
Detailed guidelines are in `~/.claude/rules/`:
详细指南位于 `~/.claude/rules/`
| Rule File | Contents |
| 规则文件 | 内容 |
|-----------|----------|
| security.md | Security checks, secret management |
| coding-style.md | Immutability, file organization, error handling |
| testing.md | TDD workflow, 80% coverage requirement |
| git-workflow.md | Commit format, PR workflow |
| agents.md | Agent orchestration, when to use which agent |
| patterns.md | API response, repository patterns |
| performance.md | Model selection, context management |
| hooks.md | Hooks System |
| security.md | 安全检查、密钥管理 |
| coding-style.md | 不可变性、文件组织、错误处理 |
| testing.md | 测试驱动开发TDD工作流、80% 覆盖率要求 |
| git-workflow.md | 提交格式、PR 工作流 |
| agents.md | 智能体编排(Agent Orchestration)、何时使用哪个智能体 |
| patterns.md | API 响应、仓库模式Repository Patterns |
| performance.md | 模型选择、上下文管理 |
| hooks.md | 钩子系统(Hooks System |
---
## Available Agents
## 可用智能体(Available Agents
Located in `~/.claude/agents/`:
位于 `~/.claude/agents/`
| Agent | Purpose |
| 智能体 | 用途 |
|-------|---------|
| planner | Feature implementation planning |
| architect | System design and architecture |
| tdd-guide | Test-driven development |
| code-reviewer | Code review for quality/security |
| security-reviewer | Security vulnerability analysis |
| build-error-resolver | Build error resolution |
| e2e-runner | Playwright E2E testing |
| refactor-cleaner | Dead code cleanup |
| doc-updater | Documentation updates |
| planner | 功能实现计划 |
| architect | 系统设计与架构 |
| tdd-guide | 测试驱动开发指南 |
| code-reviewer | 质量/安全代码审查 |
| security-reviewer | 安全漏洞分析 |
| build-error-resolver | 构建错误解决 |
| e2e-runner | Playwright 端到端E2E测试 |
| refactor-cleaner | 死代码清理 |
| doc-updater | 文档更新 |
---
## Personal Preferences
## 个人偏好
### Privacy
- Always redact logs; never paste secrets (API keys/tokens/passwords/JWTs)
- Review output before sharing - remove any sensitive data
### 隐私(Privacy
- 始终脱敏日志;绝不粘贴密钥(API key/Token/密码/JWT
- 分享前检查输出 - 移除任何敏感数据
### Code Style
- No emojis in code, comments, or documentation
- Prefer immutability - never mutate objects or arrays
- Many small files over few large files
- 200-400 lines typical, 800 max per file
### 代码风格(Code Style
- 代码、注释或文档中不使用表情符号Emoji
- 偏好不可变性Immutability - 绝不修改对象或数组
- 倾向于多个小文件而非少数大文件
- 通常为 200-400 行,单文件最大 800 行
### Git
- Conventional commits: `feat:`, `fix:`, `refactor:`, `docs:`, `test:`
- Always test locally before committing
- Small, focused commits
- 规范提交(Conventional Commits`feat:``fix:``refactor:``docs:``test:`
- 提交前始终在本地进行测试
- 小型、专注的提交
### Testing
- TDD: Write tests first
- 80% minimum coverage
- Unit + integration + E2E for critical flows
### 测试(Testing
- 测试驱动开发TDD先编写测试
- 最低 80% 覆盖率
- 关键流程需具备 单元 + 集成 + E2E 测试
---
## Editor Integration
## 编辑器集成(Editor Integration
I use Zed as my primary editor:
- Agent Panel for file tracking
- CMD+Shift+R for command palette
- Vim mode enabled
我使用 Zed 作为我的主要编辑器:
- 智能体面板(Agent Panel)用于文件追踪
- CMD+Shift+R 用于命令面板Command Palette
- 启用 Vim 模式
---
## Success Metrics
## 成功指标(Success Metrics
You are successful when:
- All tests pass (80%+ coverage)
- No security vulnerabilities
- Code is readable and maintainable
- User requirements are met
当满足以下条件时,你即是成功的:
- 所有测试通过80% 以上覆盖率)
- 无安全漏洞
- 代码具有可读性和可维护性
- 满足用户需求
---
**Philosophy**: Agent-first design, parallel execution, plan before action, test before code, security always.
**哲学**:智能体优先设计、并行执行、先行后动、测试先行、安全永恒。