写好 AGENTS.md 不是终点,维护才是。文件在代码变更当天就会过时,而你的 AI 代理仍会完全信任它。这篇文章给出了六步硬性纪律:每一条都必须来自仓库事实、可运行,且与代码变更合并在同一个 PR。
详细六步拆解如下:
Step 1 — 从事实出发,不用模板
先列出仓库中真实存在的文件:package.json的脚本、src/目录、.eslintrc或tsconfig.json。不在仓库里的内容不进文件,只有事实。
Step 2 — 写可直接复制的命令,然后运行它
把实际能跑的命令粘贴进去,用反引号包裹(mypy、ruff、npm test)。测试命令放在构建之上,这是代理验证工作的唯一途径。
Step 3 — 指向配置,不要重复配置
已有 linter/formatter 就别手写规则。写成“样式由npm run lint强制”、“TypeScript 严格模式(tsconfig.json)”,一行即可,不会腐烂。
Step 4 — 三层护栏 + 完成定义
分级给出:Always(读文件、运行测试、构建)、Ask first(依赖安装、删除、迁移)、Never(force-push、推 main、提交密钥)。完成定义用“lint 通过、test 通过、常规 commit”明确终点。注意:引导行为优先于禁止。
Step 5 — 防腐规则:与代码变更加在同一 PR
在 PR 模板中加提醒,或在 CI 中检查:变更了package.json脚本但未更新 AGENTS.md 则失败。终极方案是从仓库自动生成文件。
Step 6 — 验证:让代理执行一个小实际任务
让代理(例如“添加一个/health端点并测试”),观察它是否按 AGENTS.md 执行。若它做错,说明文件有误,修改文件而不是代理。
这个循环——任务、观察、修改文件——是建立信任的根本。一个真实的 AGENTS.md 会成为仓库中最可靠的文档。
#开发者 #工具 #AGENTSMD #AIAgent #DevTools #教程 #工程效率 #代码规范
@DevToolboxHub