第三部分,配置与安全

用 AGENTS.md 固化项目规则

把构建命令、架构约束、测试要求和目录规则写入 AGENTS.md,让每次任务共享同一基线。

AGENTS.md 是仓库级操作手册

AGENTS.md 适合记录代理每次进入仓库都需要知道的稳定规则,例如如何构建、如何测试、哪些目录由生成器维护、哪些操作需要审批。

规则要具体并能执行。与其写保持高质量,不如写修改 API 后运行哪条测试,以及生成物不能手工编辑。

markdown
# 项目规则

- 生产代码位于 src,测试位于 tests。
- 修改接口后运行 npm test 和 npm run typecheck。
- dist 是生成物,只能通过 npm run build 更新。
- 不得提交 .env 或任何 API 密钥。
- 所有数据库迁移必须提供回滚说明。

分层与维护

根目录规则适用于整个仓库,子目录可以用更具体的 AGENTS.md 补充局部约束。越靠近目标文件的说明越具体,但不应制造互相冲突的规则。

当团队发现代理重复踩坑,应把可复用的防范措施写入 AGENTS.md 或开发文档,并通过代码审查维护它。

官方资料

本页由 xueai 根据 OpenAI 官方资料重新组织并用中文讲解。产品会持续更新,涉及版本、模型和命令时请同时核对下列官方页面。