AI 编程协作
AGENTS.md / CLAUDE.md 模板
把项目里反复说明的规则,整理成一份可维护的约定。
放在哪里,给谁读取
| 工具 | 全局约定的常见位置 | 项目约定 |
|---|---|---|
| Codex | ~/.codex/AGENTS.md | 项目根目录及相关子目录的 AGENTS.md |
| Claude Code | ~/.claude/CLAUDE.md | 项目中的 CLAUDE.md |
两者都使用 Markdown,但加载规则不同。Codex 还支持 AGENTS.override.md,并按项目到当前目录的层级读取;不要以为任意位置放一个同名文件都会生效。
一份可以复制的项目约定
# 项目协作约定
## 项目入口
- 有效源码目录:[填写目录]。
- 主要技术栈:[填写语言、框架与包管理器]。
- 开发启动命令:[填写已验证的命令]。
- 需要排除的目录:[依赖、缓存、构建输出、大型数据]。
## 沟通与范围
- 使用中文说明结果;命令、路径与错误保留原文。
- 开始前查看相关文件和当前改动,保留已有工作。
- 按用户明确的目标完成任务,避免顺手改动无关模块。
- 信息不足时先完成不依赖该信息的工作,并指出缺失项。
- 用户只要求方案时,先交付方案,不修改源码。
## 实现与验证
- 遵循已有组件、命名与依赖约定。
- 不确定的第三方接口以当前官方文档为依据。
- 使用与改动范围相称的检查:[类型检查 / 测试 / 构建命令]。
- 界面变更需检查实际页面、键盘操作与手机布局。
- 不能运行的检查要说明原因,不把未验证写成已通过。
## 数据与发布
- 密钥、密码、Cookie 和私人数据不写入源码或日志。
- 删除数据、变更权限或发布前核对具体范围和已有授权。
- 临时产物放在:[填写目录];保留现用数据和回退路径。
## 交付
- 说明最终行为、相关文件、验证结果与剩余限制。
- 区分本地源码已改、本地预览可用和正式环境已更新。规则具体,才容易执行
把“注意质量”改为具体的验证方法;把“不要乱改”改为明确的允许目录、必须保留的接口和数据。规则里不要放密钥,也不要堆入与所有任务无关的长文。
经常变化的版本、价格和接口应指向可靠来源。项目事实更新后同步维护规则,避免旧路径与新路径同时出现在说明里。
确认规则真的被读取
重新开启一个项目任务,让工具说明它读取的规则来源、工作目录和验证命令。若没有生效,检查文件名、当前目录、覆盖文件和客户端版本。
发现内容有误,或有未解答的问题?反馈文档问题 ↗