OpenAI推出AI编程手册OpenAI牵头制定AI编程标准
OpenAI牵头,推出一个专门写给AI编程助手(Coding agents)看的说明文档,叫AGENTS.md。
简单说,它就像是给AI看的README,但只写机器需要的那部分,比如项目怎么跑、代码怎么写、测试怎么过,专门让AI更好“接手”开发任务而设计。
一、AGENTS.md的目标是两个:
- 给AI一个明确的“任务入口”,能直接读取关键信息,不用再去猜
- 避免把README写得太杂太重,方便人类和AI各取所需
二、打开AGENTS.md,大概会看到这些内容:
- 环境配置、依赖安装命令(比如`pnpm install`)
- 项目如何运行、测试、部署
- 代码风格要求,比如用TypeScript严格模式、无分号、函数式写法
- PR标题格式、提交规范等
三、如果你要用AGENTS.md,可以按下列步骤操作:
1. 添加AGENTS.md文件:在代码库根目录创建一个AGENTS.md文件,大多数AI助手也能根据项目内容帮你自动生成初始模板。
2. 写清关键信息:补充AI理解项目所需的内容,比如、项目简介、构建和测试命令、代码风格规范、测试流程说明、安全注意事项等。
3. 加入额外说明:像是提交规范、PR格式、大文件处理、部署流程等团队内部经验,也都可以一并写进去,相当于写给“AI新同事”的入职指南。
4. 多项目结构下分包设置:如果是大型monorepo,可以在每个子包里再放一个独立的AGENTS.md,AI会自动优先读取离目标文件最近的那份。OpenAI自己的主仓库里,就有88个AGENTS.md。
目前,已经有超过2万个开源项目在用这个格式,背后除了OpenAI,还有Google、Cursor等多个AI开发团队参与。
相比传统那种“工具专用配置文件”,AGENTS.md用的是普通Markdown格式,名字也简单易记,完全开放,任何AI工具都能读。
这个标准目前已上线官网:agents.md,也同步开源到了GitHub:openai/agents.md。
有开发者表示:AI“编程助手”要真能用好,那就必须先教它怎么“接手”项目,而AGENTS.md,正是它能读懂的那本“操作手册”。