Files
vibe-coding-cn/docs/workflow/AGENTS.md
T
2026-05-05 06:03:48 +08:00

1.3 KiB

workflow Agent 指南

目录职责

docs/workflow/ 存放项目开发流程类 Markdown,是开发顺序、质量门禁、版本控制和文档同步规则的流程入口。

文件地图

workflow/
├── README.md  # 线性总文档:开发流程集合
└── AGENTS.md  # 本目录操作规则

修改规则

  • 继承 docs/AGENTS.md 的 README 结构契约:H1 后直接进入 ## 字多不看,再按 快速导航 -> 完整细粒度目录 -> 使用方式 -> 正文 排列。
  • 本目录只放流程类文档,不放一次性任务记录、日志、源码快照或私密配置。
  • 新增流程时优先追加到 README.md,不新增同级主题 .md 文件。
  • 新增流程必须能被执行、检查和复用,避免只写抽象口号。
  • 涉及命令、路径、配置、CI、Git 操作时,必须与仓库当前事实一致。
  • 不在本目录保存密钥、Token、本地账号、真实私有项目配置或一次性日志。
  • 架构、目录、命令或质量门禁发生变化时,同步更新本目录和根 README.md / AGENTS.md
  • 不在 README 正文中写 和其他目录的边界维护规则;维护者规则只写本文件。
  • 不确定项标注 TODO,并说明需要哪个文件或命令输出才能确认。

验证

make test