AGENTS.md 初始化示例
这份文件用于给 Codex 和其他通用 AI 编程 agent 提供项目级工作协议。它应该放在仓库根目录，文件名保持为 AGENTS.md。当项目存在子目录级规则时，也可以在子目录再放一个更具体的 AGENTS.md。
推荐放置位置
text
project-root/
AGENTS.md
README.md
package.json
docs/
project/
requirements.md
acceptance.md
architecture.md
test-strategy.md
risk-register.md可直接使用的模板
markdown
# AGENTS.md
## 项目概览
本项目是一个 AI 项目交付看板，面向项目经理、开发、测试和干系人。
第一版聚焦一个可用的 Web 应用：
- 创建和编辑项目交付任务。
- 跟踪任务状态、负责人、优先级、截止日期和 AI 协助备注。
- 展示阻塞、进行中和已完成任务的看板统计。
- 保持实现足够小，能在一次培训中完成构建、测试和审查。
## 技术栈
- 前端：React、TypeScript、Vite。
- 样式：CSS Modules 或普通 CSS；除非明确要求，不添加 UI 框架。
- 状态：v1 使用组件本地状态；不要添加 Redux 或 Zustand。
- 持久化：v1 使用浏览器 localStorage；不要添加数据库。
- 测试：单元测试使用 Vitest；条件允许时用 Playwright 做一个冒烟流程。
## 常用命令
- 安装依赖：`npm install`
- 开发服务：`npm run dev`
- 构建：`npm run build`
- 单元测试：`npm run test`
- Lint：`npm run lint`
如果命令不存在，先检查 `package.json`，使用最接近的可用命令。不要在没有说明原因的情况下新增脚本。
## 工作规则
- 修改代码前先阅读 `README.md` 和 `docs/project/*.md`。
- 用能满足当前验收标准的最小改动完成任务。
- 优先沿用项目已有模式，不轻易新增抽象。
- 除非任务明确要求，不添加依赖。
- 不编辑生成文件、依赖目录、构建产物、截图或压缩包。
- 面向用户的文案保持简洁，适合开发和项目经理阅读。
- 保留工作区中与当前任务无关的用户改动。
## 实现流程
1. 复述任务，并识别可能修改的文件。
2. 检查现有实现。
3. 对非平凡改动给出简短计划。
4. 小步实现。
5. 运行相关验证命令。
6. 总结修改文件、验证结果和剩余风险。
## 验收标准
任务只有在满足以下条件时才算完成：
- 请求的功能或文档已经能在应用或文档站中看到。
- 相关构建或测试命令通过。
- 最终说明包含修改内容和验证方式。
- 任何已知缺口都被明确说明。
## 安全要求
- 不提交密钥、token、cookie 或私钥。
- 登录、授权、文件上传、Shell 执行和外部 API 调用都按高风险区域处理。
- 在边界处校验用户输入。
- 不为了让演示通过而削弱现有安全检查。
## Git
- 保持提交聚焦。
- 在本仓库工作时使用中文提交信息。
- 除非明确要求，不改写 Git 历史。课堂讲解重点
AGENTS.md 不是提示词收藏夹，而是项目协议。适合放长期有效的规则，例如技术栈、命令、目录边界、完成标准、安全要求和 Git 规则。不适合放一次性需求、临时日志、聊天记录或尚未确认的想法。
Codex 操作提示
text
请先阅读 AGENTS.md、README.md 和 docs/project/*.md。
只分析，不改文件。请输出你理解到的项目规则、风险点、计划修改文件和验证命令。确认计划后再输入：
text
按上面的计划实现第一版。每完成一个小步骤后运行相关验证，最后给出变更摘要和风险。