AGENTS.md的最佳实践指南
这个特殊配置文件相当于AI的「项目入职手册」,建议包含以下核心内容:
- 测试规范:明确测试命令(如
pytest
)、覆盖率要求及运行路径 - 代码风格:定义linter配置(如
flake8
)、格式化标准等 - 模块说明:标注关键文件路径及其功能,例如
src/core/auth.py
处理认证逻辑 - 工作流约束:指定PR信息格式、提交规范等协作要求
文件应放置在项目根目录或多级子目录中(遵循就近优先级原则)。典型案例显示,配有完善AGENTS.md的项目中,Codex任务一次通过率可提升60%以上。对于复杂项目,建议参照文中示例建立层级化的指导文件。
本答案来源于文章《ChatGPT Codex:自动执行软件工程任务的智能体》