乐于分享
好东西不私藏

项目级 AGENTS 模板

项目级 AGENTS 模板

用途:给具体项目直接改写使用建议:复制后按项目实际情况替换占位内容,不要原样照搬

# AGENTS.md## Project Map- `src/`: [一句话说明]- `tests/`: [一句话说明]- `docs/`: [一句话说明]- [如果是多子系统仓库,在这里列出 api/web/packages 等]## Read First- 修改 `[目录A]` 前,先读 `[目录A]/AGENTS.md`- 修改 `[目录B]` 前,先读 `[目录B]/AGENTS.md`- 涉及复杂流程时,先看 `[docs/... 或 PLANS.md]`## Commands- Install: `[安装命令]`- Format: `[格式化命令]`- Lint: `[lint 命令]`- Typecheck: `[类型检查命令]`- Tests: `[测试命令]`## Rules- 不要直接修改 `[生成文件 / 构建产物 / vendor 目录]`- 不要绕过 `[CI / 部署流程 / 审批流程]`- 优先复用 `[现有模块 / 既有工具链 / 既有脚本]`- 行为变更必须同步更新 `[测试 / 文档 / 快照 / 示例]`## Completion Rules- 改 runtime 代码:运行 `[format -> lint -> typecheck -> tests]`- 改 docs-only 内容:运行 `[文档校验命令]`- 改 UI-visible 内容:更新 `[快照 / 示例 / i18n / 设计文档]`## Escalate Before Changing- 公共 API / schema / migration- 构建与部署行为- 安全敏感逻辑- 需要新增依赖或修改关键约束的改动## External Docs- 复杂实现:`[PLANS.md 或 docs/... ]`- 部署/回滚:`[docs/ops/... ]`- 参考资料:`[docs/reference/... ]`

改写提示

写项目版 AGENTS.md 时,只保留:

  • 高频且稳定的规则
  • 代码里不容易推断出的项目特有约定
  • 高风险坑点
  • agent 最容易误判完成的地方

不要把这些塞进根文档:

  • 完整部署手册
  • 低频长流程
  • 一次性任务说明
  • 泛化编码鸡汤

建议长度

  • 根级 AGENTS.md:目标 80-150 行
  • >200 行进入警戒
  • 超过后优先拆目录级 AGENTS.md 或外部 docs

如果项目很小,可以更短;如果是 monorepo,也尽量先把根文档写成“地图页”,不要写成总手册。