Codex 零基础教程(七):项目协作与 AGENTS.md
#Codex#AGENTS.md#项目协作#代码安全
2026年 8月 10日 · 约 2 分钟读完
前一篇练习的是一个文件。这一篇开始把方法迁移到真实项目,但仍然坚持小范围、可恢复、可验证。你会用 AGENTS.md 把项目规则写下来,让每次打开项目时都不用重复解释。
本文核对时间:2026-08-10。不同客户端对项目规则文件的读取方式可能不同,使用前请查看当前工具文档。
你将完成什么
- 判断项目根目录;
- 写一份最小的
AGENTS.md; - 让 AI 先读规则和项目结构;
- 规定修改范围、验证命令和完成标准。
什么是项目根目录
项目根目录通常是包含 package.json、README.md、.git 或主要配置文件的那一层。不要把 AI 直接打开到整个硬盘、下载目录或包含私人资料的父目录。
打开项目后,先让 AI 执行只读检查:
请先确认当前工作目录,列出一级文件和可用的开发命令。只读,不修改文件。如果列出的目录不是你预期的项目,先关闭任务,重新选择项目根目录。
第一步:创建最小规则文件
在项目根目录创建 AGENTS.md,可以从下面这份模板开始:
# 项目协作规则
## 项目概况
这是一个需要保持现有目录结构的前端项目。
## 修改规则
- 修改前先阅读相关文件和现有实现。
- 只修改完成当前任务所需的文件。
- 不删除用户已有的未完成修改。
- 不读取、打印或提交密钥和个人资料。
## 验证命令
- 安装:`pnpm install`
- 构建:`pnpm build`
## 完成标准
- 说明修改了哪些文件;
- 说明运行了哪些检查;
- 如果没有运行检查,明确说明原因。把命令换成你项目真实使用的命令。不要把示例直接复制到生产仓库后就当成完成。
第二步:让 AI 先读规则
在项目目录里发送:
请先阅读 AGENTS.md 和项目根目录的 README.md。总结项目结构、可用命令和本次任务需要遵守的限制。暂时不要修改文件。如果 AI 直接开始改文件,停止任务并检查它是否在正确的项目目录、规则文件是否命名正确、客户端是否支持该规则文件。
第三步:用范围限制任务
给真实项目下任务时,至少写清四件事:
- 目标:要解决什么问题;
- 范围:允许修改哪些文件或目录;
- 禁止事项:哪些文件不能碰;
- 验证:完成后运行什么命令或进行什么人工检查。
示例:
目标:修复首页移动端卡片文字溢出。
范围:只检查 src/app/(home)/ 和相关样式文件。
禁止:不要修改 API、数据库、部署脚本和无关文章。
验证:说明原因,修改后运行 pnpm build,并在 390px 宽度检查首页。
请先给计划,不要立即修改。第四步:查看 diff 再验收
AI 报告完成后,不要只看总结。你需要确认:
- 修改文件是否都在允许范围内;
- 是否有不必要的大量格式化;
- 是否删除了原有逻辑或内容;
- 测试和构建是否真的运行过;
- 页面或功能是否符合原任务,而不是只让错误消失。
如果使用 Git,可以先查看:
git status --short
git diff --stat
git diff -- path/to/changed-file这些命令只查看变化,不会自动接受或撤销修改。
如果要撤销
优先使用编辑器、Git 或项目已有的恢复方式,先确认目标文件和未提交修改。不要在不清楚范围时执行会覆盖整个工作区的命令。
完成检查
- AI 工作在正确的项目根目录;
-
AGENTS.md写了真实的项目命令; - 任务有明确范围和禁止事项;
- 修改前先给了计划;
- 我查看了 diff,而不是只看 AI 总结;
- 我知道如何恢复这次修改。
下一步
继续阅读第八章:任务拆解与验收,学习如何把一句模糊需求写成 AI 可以执行的任务。