AGENTS.md – Open format for guiding coding agents
9 months ago
- #coding-agents
- #documentation
- #open-source
- AGENTS.md 是一种简单、开放的格式规范，用于指导编程智能体，已被超过2万个开源项目采用。
- 它作为专用且可预测的配置位点，为参与项目的AI编程助手提供上下文和操作指引。
- 该文件对README.md形成补充，包含构建步骤、测试方案等可能污染README的详细技术上下文。
- 标准格式包含环境配置命令、代码风格、开发环境建议、测试指南和PR规范等模块。
- 其设计兼容性可适配日益增长的AI编程工具生态体系。
- 推荐包含的核心模块有：项目概览、构建测试命令、代码风格规范、测试说明及安全注意事项。
- 大型单体仓库可采用嵌套式AGENTS.md文件管理子项目。
- 该标准诞生于AI开发生态系统的协作成果，参与者包括OpenAI Codex、Amp、谷歌Jules、Cursor和Factory等团队。
- 作为开放标准持续维护，以惠及全体开发者社区。
- 常见问题涵盖必填字段、指令冲突处理、自动化测试命令、文档更新策略及现有文档迁移方案等主题。