AGENTS.md采用标准Markdown语法,主要内容模块根据项目需求可自由组合,但通常包含以下关键部分:
- 开发环境设置:指导AI配置本地环境(如包管理器使用示例)
- 测试指令规范:明确测试执行流程和验收标准
- 代码提交规则:定义PR/Ccommit的格式要求
典型结构示例:
- 使用
pnpm dlx turbo
等精确命令替代模糊指令 - 指定测试套件执行路径和通过标准
- 规定commit信息模板和lint检查流程
这些模块共同构成AI参与项目开发的”SOP”,确保其输出符合工程规范。
本答案来源于文章《AGENTS.md:为AI编程智能体提供指导的开放格式文件》