mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-12 20:53:34 +08:00
Revert "feat(ecc): prune plugin 43→12 items, promote 7 rules to .claude/rules/ (#245)"
This reverts commit 1bd68ff534.
This commit is contained in:
100
docs/zh-CN/examples/CLAUDE.md
Normal file
100
docs/zh-CN/examples/CLAUDE.md
Normal file
@@ -0,0 +1,100 @@
|
||||
# 示例项目 CLAUDE.md
|
||||
|
||||
这是一个示例项目级别的 CLAUDE.md 文件。请将其放置在您的项目根目录下。
|
||||
|
||||
## 项目概述
|
||||
|
||||
\[项目简要描述 - 功能、技术栈]
|
||||
|
||||
## 关键规则
|
||||
|
||||
### 1. 代码组织
|
||||
|
||||
* 多个小文件优于少量大文件
|
||||
* 高内聚,低耦合
|
||||
* 每个文件典型 200-400 行,最多 800 行
|
||||
* 按功能/领域组织,而非按类型
|
||||
|
||||
### 2. 代码风格
|
||||
|
||||
* 代码、注释或文档中不使用表情符号
|
||||
* 始终使用不可变性 - 永不改变对象或数组
|
||||
* 生产代码中不使用 console.log
|
||||
* 使用 try/catch 进行适当的错误处理
|
||||
* 使用 Zod 或类似工具进行输入验证
|
||||
|
||||
### 3. 测试
|
||||
|
||||
* TDD:先写测试
|
||||
* 最低 80% 覆盖率
|
||||
* 工具函数进行单元测试
|
||||
* API 进行集成测试
|
||||
* 关键流程进行端到端测试
|
||||
|
||||
### 4. 安全
|
||||
|
||||
* 不硬编码密钥
|
||||
* 敏感数据使用环境变量
|
||||
* 验证所有用户输入
|
||||
* 仅使用参数化查询
|
||||
* 启用 CSRF 保护
|
||||
|
||||
## 文件结构
|
||||
|
||||
```
|
||||
src/
|
||||
|-- app/ # Next.js app router
|
||||
|-- components/ # Reusable UI components
|
||||
|-- hooks/ # Custom React hooks
|
||||
|-- lib/ # Utility libraries
|
||||
|-- types/ # TypeScript definitions
|
||||
```
|
||||
|
||||
## 关键模式
|
||||
|
||||
### API 响应格式
|
||||
|
||||
```typescript
|
||||
interface ApiResponse<T> {
|
||||
success: boolean
|
||||
data?: T
|
||||
error?: string
|
||||
}
|
||||
```
|
||||
|
||||
### 错误处理
|
||||
|
||||
```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' }
|
||||
}
|
||||
```
|
||||
|
||||
## 环境变量
|
||||
|
||||
```bash
|
||||
# Required
|
||||
DATABASE_URL=
|
||||
API_KEY=
|
||||
|
||||
# Optional
|
||||
DEBUG=false
|
||||
```
|
||||
|
||||
## 可用命令
|
||||
|
||||
* `/tdd` - 测试驱动开发工作流
|
||||
* `/plan` - 创建实现计划
|
||||
* `/code-review` - 审查代码质量
|
||||
* `/build-fix` - 修复构建错误
|
||||
|
||||
## Git 工作流
|
||||
|
||||
* 约定式提交:`feat:`, `fix:`, `refactor:`, `docs:`, `test:`
|
||||
* 切勿直接提交到主分支
|
||||
* 合并请求需要审核
|
||||
* 合并前所有测试必须通过
|
||||
Reference in New Issue
Block a user