AGENTS.md 项目规则

AGENTS.md 可以理解为写给 Codex 的项目说明书。它适合记录项目约定、测试命令、代码风格、禁止改动的目录，以及完成任务前必须做的检查。

适合写什么

• 项目技术栈和主要目录说明
• 常用开发、测试、构建命令
• 代码风格、命名规则、提交规范
• 哪些文件或目录不能随便改
• 任务完成前需要跑哪些验证
• 团队希望 Codex 汇报结果的格式

示例

# AGENTS.md

## 项目说明

这是一个 Nuxt 内容站点，文档在 content/1.codex 下。

## 常用命令

- 类型检查：npm run typecheck
- 构建：npm run build

## 工作要求

- 修改 Markdown 时保持中文表达简洁
- 不要提交真实 API Key、兑换码或账号信息
- 修改前先查看同目录已有文档风格
- 完成后说明验证命令和结果

放在哪里

通常放在项目根目录。对于大型项目，也可以在子目录放更细的规则文件，让 Codex 在处理该目录时读取更具体的约束。

使用建议

AGENTS.md 不需要一开始写得很长。先写最容易出错的规则，例如测试命令、禁止改动目录和密钥安全。随着项目迭代，再把重复提醒逐步沉淀进去。