AGENTS.md 项目规则

AGENTS.md 是给 Codex 这类编码代理看的项目说明文件。它可以描述项目结构、开发命令、测试要求、代码风格和协作边界。

最后核对

AGENTS.md 机制请以 openai/codex GitHub repository 及其文档为准。最后核对日期：2026-05-02。

AGENTS.md

没有项目规则时，Codex 需要从仓库里推断很多事情：

• 用哪个包管理器。
• 如何运行测试。
• 哪些目录是生成物。
• 哪些文件不能改。
• 提交前要跑哪些检查。

AGENTS.md 能把这些规则显式写下来，减少反复解释。

推荐模板

# AGENTS.md

## 项目概览

- 项目类型：
- 主要语言：
- 关键目录：

## 常用命令

- 安装依赖：`...`
- 本地开发：`...`
- 运行测试：`...`
- 类型检查：`...`
- 格式化：`...`

## 代码规范

- 遵循现有代码风格。
- 不做无关重构。
- 新增功能必须补充或更新测试。

## 安全边界

- 不读取或提交 `.env`、密钥和私有凭据。
- 不执行删除生产数据的命令。
- 修改数据库迁移前先说明影响。

## 交付要求

- 说明改动文件。
- 说明验证命令和结果。
- 说明未验证项和剩余风险。

写作建议

• 越具体越好。运行测试：pnpm test 比“记得测试”有用。
• 把生成目录、构建产物、锁文件策略写清楚。
• 如果是 monorepo，请说明每个包的边界。
• 如果有特殊 lint、格式化或代码生成流程，写在命令区。
• 对安全敏感项目，单独写“禁止事项”。