2.6 KiB
2.6 KiB
AGENTS.md
Codex / AI coding agent 的仓库级入口。进入本仓库后,先读本文,再进入
docs/00-ai-start-here.md。
项目定位
本仓库是 harness coding 文档样本库,用来沉淀一个新项目交给 AI coding agent 开发前应准备的文档集合。
当前不是业务应用代码仓库,而是文档模板仓库。默认任务是维护、改进、补充这些模板,让它们更适合复制到新项目中使用。
文档位置
harness coding 需要的项目文档模板主要集中在 docs/ 目录;根目录还包含 progress.md 执行流水模板。
后续 Codex 或其他 AI coding agent 进入使用这些模板的新项目时,应先读取仓库级规则文件,再从 docs/00-ai-start-here.md 开始建立上下文;该文件会继续导航到需求、技术栈、架构、编码规则、任务看板、执行流水和当前状态。
根目录 README.md 和 docs/README.md 主要用于人类快速了解样本库和文档清单;agent 真正开始编程时,以 docs/00-ai-start-here.md 作为工作入口。
必读顺序
每次开始工作前,按顺序读取:
README.md:了解本仓库用途和文档集合。docs/README.md:了解文档导航。docs/00-ai-start-here.md:理解新项目中 agent 的入口流程。docs/05-coding-rules.md:理解模板中的编码纪律。progress.md:理解执行流水和当前状态的职责边界。- 与当前任务相关的具体文档。
如果用户要求修改某类模板,优先阅读对应文件,不要只凭文件名猜内容。
工作规则
- 保持这些文件是“可复制到新项目”的模板,不要写入只适用于当前机器的业务事实。
- 可以引用
D:\opc_project\lingo\docs作为参考来源,但不要把 lingo 的具体业务内容照搬进通用模板。 - 文档中使用
【占位符】表示新项目需要替换的内容。 - 修改导航时,必须同步检查
README.md和docs/README.md的链接。 - 新增文档时,必须在根目录
README.md和docs/README.md中登记。 - 不要删除已有模板,除非用户明确要求。
风格
- 文档默认使用中文。
- 标题、表格、任务状态、文件名保持简洁稳定。
- 内容要面向 agent 执行,而不是泛泛讲原则。
- 每条规则最好能落到“读取什么、修改什么、验证什么”。
验证
本仓库目前是纯文档仓库。修改后至少检查:
Get-ChildItem -Recurse -File
如修改链接或文件名,使用 rg 搜索旧名称和新名称,确认引用一致。