AGENTS.md 指令文件 · AGENTS.md
名为 AGENTS.md 的项目指令文件,用于向支持它的编程智能体说明项目约定。
详细说明
AGENTS.md 是应保留原样的文件名,不是所有项目说明文档的统称。文件可包含目录结构、构建命令、代码约定与检查要求。是否自动读取、何时读取以及子目录文件的适用范围,由具体工具决定,不能假定所有助手都按同一规则加载。
使用示例
在 AGENTS.md 中说明使用 pnpm,并列出修改后必须运行的检查。
名为 AGENTS.md 的项目指令文件,用于向支持它的编程智能体说明项目约定。
AGENTS.md 是应保留原样的文件名,不是所有项目说明文档的统称。文件可包含目录结构、构建命令、代码约定与检查要求。是否自动读取、何时读取以及子目录文件的适用范围,由具体工具决定,不能假定所有助手都按同一规则加载。
在 AGENTS.md 中说明使用 pnpm,并列出修改后必须运行的检查。