技术 · 熟练
每个 AI 都要重新摸一遍你的项目?写一份 AGENTS.md
AGENTS.md 是放在仓库根的一份 Markdown,写给 AI 看的项目说明书 —— 构建命令、测试指令、代码风格、协作约定四类内容写进去,agent 开工前读一次就够。它解决的是:每换一个工具、每开一次新会话,AI 都要花十几分钟反推你的仓库结构,还经常推错。怎么做:在仓库根新建 AGENTS.md,只写「每次开工都要知道」的,命令写成能直接复制执行的形状。项目里没有 CLAUDE.md 时,Claude Code 会改读这个文件;文件名是跨工具的约定,换工具不用重写。
1
在仓库根建这份文件 — 与 README 同级 · 文件名固定 `AGENTS.md`(⛔ 不另起名)
2
先写四类硬信息 — 构建命令 / 测试指令 / 代码风格 / 协作约定(如提交信息格式)
3
只留「每次都要用」的 — 一次性的迁移说明、临时待办不进来;写进来就得每次都被读
4
命令写成可复制的 — 写 `pnpm test:unit`,不写「按项目测试规范执行」
5
换工具时复用它 — 没有 CLAUDE.md 的项目,Claude Code 直接读它;其它编码工具也认这个文件名
# 角色
你是本仓库的编码助手。开工前先读本文件,不要靠猜测仓库结构。
# 输入说明
你需要先知道三件事:① 这是什么项目(一句话)② 本地怎么跑起来 ③ 什么算「改对了」。
若本文件缺少上述任一项,先向我提问,⛔ 不要自行假设。
# 方法(按顺序执行)
1. 读本文件 → 复述一遍本项目用到的构建命令与测试命令。
2. 若本文件未列出我要改的模块的约定,先问我,⛔ 不要照搬其它模块的风格。
3. 改完代码后,运行「验证命令」并把输出贴给我:
- 单元测试:`[填写本项目的单测命令,如 pnpm test:unit]`
- 类型检查:`[填写本项目的类型检查命令,如 pnpm typecheck]`
4. 若验证失败,先定位到具体断言,再改一次;连续两次不过就停下来汇报。
# 输出格式
| 项 | 内容 |
|---|---|
| 改了哪些文件 | 路径列表 |
| 每条改动做什么 | 一句话 |
| 验证命令与结果 | 命令 + 通过/失败 |
| 我没把握的地方 | 明确列出,不要隐藏 |
# 约束
- ⛔ 不执行删除文件、改数据库结构、发版、推送远端这类不可逆动作(要执行须先问我)。
- ⛔ 不改本文件里没提到的目录。
- ⛔ 不引入新依赖,除非我在本轮明确要求。
- 拿不到答案时提问,不要用「通常来说」把假设写进代码。
# 项目约定(按实际填写)
- 构建:`[填写构建命令]`
- 测试:`[填写测试命令]`
- 代码风格:`[填写,如 2 空格缩进 / 单引号 / 提交信息用动词开头]`
- 不要动的目录:`[填写,如 build/ dist/ vendor/]`