主题
推荐全局规则
在使用 AI 编程工具时,配置好全局规则可以显著提升代码生成质量。以下是针对不同工具的推荐配置。
Claude Code — CLAUDE.md
在项目根目录创建 CLAUDE.md,Claude Code 启动时会自动读取。
基础模板
markdown
# CLAUDE.md
## 项目概述
[简要描述项目功能]
## 技术栈
- 语言:[如 TypeScript / Python / Go]
- 框架:[如 Next.js / FastAPI / Gin]
- 数据库:[如 PostgreSQL / MongoDB]
## 代码规范
- 使用 [ESLint/Prettier/Black] 格式化代码
- 函数命名使用 camelCase
- 组件命名使用 PascalCase
- 中文注释
## 常用命令
- `npm run dev` — 启动开发服务器
- `npm test` — 运行测试
- `npm run build` — 构建生产版本
## 注意事项
- 不要修改 .env 文件
- 数据库迁移走 migration,不直接改 schema进阶配置
markdown
## 架构约束
- 优先使用已有工具函数,不重复造轮子
- 新增 API 端点必须包含输入校验
- 数据库查询使用参数化查询,防止注入
- 错误处理统一使用项目的 error handler
## 测试要求
- 新功能必须包含单元测试
- 测试覆盖率不低于 80%
- Mock 外部依赖,不依赖真实网络请求Cursor — .cursorrules
在项目根目录创建 .cursorrules 文件。
基础模板
text
你是一个专注于 [项目类型] 的高级开发者。
技术栈:[技术栈列表]
代码风格:
- 使用 TypeScript strict mode
- 优先使用函数式编程风格
- 组件使用 React Hooks,不用 class component
- 样式使用 Tailwind CSS
命名规范:
- 文件名:kebab-case
- 组件名:PascalCase
- 函数名:camelCase
- 常量名:UPPER_SNAKE_CASE
回复语言:中文Codex CLI — codex.md
Codex CLI 支持在项目根目录放置 codex.md 作为上下文规则。
基础模板
markdown
# codex.md
## 项目规范
- 使用 Python 3.12+
- 类型标注使用 typing 模块
- 文档字符串使用 Google 风格
## 依赖管理
- 使用 uv 管理依赖
- 不引入不必要的第三方库通用的最佳写法
无论使用哪个工具,好的全局规则都遵循以下原则:
1. 明确技术栈
告诉 AI 你用什么,它会生成匹配的代码:
text
✅ "使用 React 19 + TypeScript 5.7 + Tailwind CSS 4"
❌ "用 React 写前端"2. 指定禁止项
提前声明不想要的东西比事后修改高效:
text
✅ "不要使用 any 类型" "不要使用 class component"
❌ (不说,然后手动改)3. 给出常用命令
让 AI 知道如何验证自己的输出:
text
✅ "运行测试:npm test,lint:npm run lint"
❌ (AI 不知道怎么检查自己写的代码对不对)4. 保持简洁
规则文件不是文档站,保持在 50-100 行以内。过长的规则文件反而会降低效果。
