refactor(agent-collaboration-kit): split stable core from project overrides
- Reorganize flat files into core/ templates/ examples/ scripts/ with VERSION - Deduplicate: single-source state machine, three-round policy, acceptance signals - Abstract orchestration in closed-loop.md with manual mode; move Orca commands to orca-adapter.md - Add tasks.schema.json + validate_tasks.py (jsonschema or builtin rules, no hard deps) - Add filled examples, concurrency write rule, kitVersion tracking; unify to Chinese Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
@@ -1,74 +1,59 @@
|
||||
# Adoption Checklist
|
||||
# 接入清单
|
||||
|
||||
复制本工具包到新项目后,按这份清单接入。
|
||||
把本工具包引用/复制到新项目后,按此清单接入。术语与规则详见 `core/`。
|
||||
|
||||
## 1. 项目级规范
|
||||
## 1. 分发与版本
|
||||
|
||||
- [ ] 根目录存在 `AGENTS.md`。
|
||||
- [ ] `AGENTS.md` 引用 `docs/agent-collaboration-kit/`。
|
||||
- [ ] 写清项目简介和技术栈。
|
||||
- [ ] 写清本地运行命令。
|
||||
- [ ] 写清构建命令。
|
||||
- [ ] 写清单元测试命令。
|
||||
- [ ] 写清集成测试或浏览器测试命令。
|
||||
- [ ] 选定分发方式(README §「分发方式」A 引用 / B 复制)。
|
||||
- [ ] kit 放到 `docs/agent-collaboration-kit/`。
|
||||
- [ ] 项目 `AGENTS.md` 与 `tasks.yaml` 记录 `kitVersion`(对齐 kit 根 `VERSION`)。
|
||||
|
||||
## 2. 路径权限
|
||||
## 2. 项目级规范(覆盖层)
|
||||
|
||||
- [ ] Product/Test 可写规格路径:`<spec_paths>`。
|
||||
- [ ] Product/Test 可写集成测试路径:`<integration_test_paths>`。
|
||||
- [ ] Developer 可写源码路径:`<source_paths>`。
|
||||
- [ ] Developer 可写单元测试路径:`<unit_test_paths>`。
|
||||
- [ ] 本地私有配置标记为只读或不提交。
|
||||
- [ ] 明确 `tasks.yaml` 状态字段谁可以改。
|
||||
- [ ] 由 `templates/AGENTS.template.md` 生成项目根 `AGENTS.md`。
|
||||
- [ ] `AGENTS.md` 引用 `docs/agent-collaboration-kit/core/`,不复制其内容。
|
||||
- [ ] 填清项目简介、技术栈、运行/构建/单测/集成测试命令。
|
||||
|
||||
## 3. 任务板
|
||||
## 3. 路径权限
|
||||
|
||||
- [ ] 从 `task-board-template.yaml` 创建项目根目录 `tasks.yaml`。
|
||||
- [ ] 填实际的 Product/Test 可写路径(规格、集成测试、复测记录)。
|
||||
- [ ] 填实际的 Developer 可写路径(源码、单元测试、配置模板)。
|
||||
- [ ] 本地私有配置标记只读或不提交。
|
||||
- [ ] 确认 `tasks.yaml` 只有 Coordinator 写(见 `core/roles-and-permissions.md`)。
|
||||
|
||||
## 4. 任务板
|
||||
|
||||
- [ ] 由 `templates/tasks.template.yaml` 生成项目根 `tasks.yaml`。
|
||||
- [ ] 替换 `<project_name>`、`<repo_path>`、`<base_url>`、`<dev_worktree>`。
|
||||
- [ ] 至少添加一个示例任务,验证字段结构够用。
|
||||
- [ ] 约定状态:`open`、`dispatched`、`fixed_by_dev`、`retesting`、`verified`、`leftover`。
|
||||
- [ ] 至少加一个真实任务,验收写成可观测信号(见 `core/optimization-method.md` §1)。
|
||||
- [ ] 跑 `scripts/validate_tasks.py tasks.yaml` 通过。
|
||||
|
||||
## 4. Orca 编排
|
||||
## 5. 编排
|
||||
|
||||
- [ ] `orca status --json` 可用。
|
||||
- [ ] `orca terminal list --json` 能看到 Coordinator 终端。
|
||||
- [ ] 能创建或复用 Developer Worker。
|
||||
- [ ] 决定默认使用当前 worktree 还是隔离 worktree。
|
||||
- [ ] 验证 `worker_done` 能发回 Coordinator。
|
||||
- [ ] 决定用 Orca(`core/orca-adapter.md`)还是手动模式(`core/closed-loop.md`)。
|
||||
- [ ] Orca:`orca status`、`terminal list` 可用,`worker_done` 能发回 Coordinator。
|
||||
- [ ] 决定用当前 worktree 还是隔离 worktree。
|
||||
|
||||
## 5. 验证命令
|
||||
## 6. 验证命令
|
||||
|
||||
- [ ] Product/Test 有黑盒验证命令。
|
||||
- [ ] Developer 有白盒验证命令。
|
||||
- [ ] 构建产物和服务启动命令写清楚。
|
||||
- [ ] 浏览器测试的 `BASE_URL` 写清楚。
|
||||
- [ ] 复测前能确认服务来自正确 worktree。
|
||||
- [ ] Product/Test 有黑盒验证命令,Developer 有白盒验证命令。
|
||||
- [ ] 构建产物与服务启动命令写清。
|
||||
- [ ] 浏览器测试 `BASE_URL` 写清,复测前能确认服务来自正确 worktree。
|
||||
|
||||
## 6. 三轮失败策略
|
||||
## 7. 三轮失败策略
|
||||
|
||||
- [ ] 每个任务记录 `rounds` 或等效 evidence。
|
||||
- [ ] 三轮失败后标记 `leftover`。
|
||||
- [ ] `leftover` 不阻塞继续处理其他任务。
|
||||
- [ ] 最终报告列出所有 `leftover` 和最后失败证据。
|
||||
- [ ] 每个任务记录 `dispatch.rounds`。
|
||||
- [ ] 三轮失败标记 `leftover` 并填 `resolution.leftoverReason`。
|
||||
- [ ] `leftover` 不阻塞其它任务;最终报告列出所有 `leftover` 与最后失败证据。
|
||||
|
||||
## 7. 第一次试运行
|
||||
## 8. 第一次试运行
|
||||
|
||||
推荐选择一个低风险 bug 跑完整流程:
|
||||
|
||||
1. Product/Test 写入 `tasks.yaml`。
|
||||
2. 创建 Orca task。
|
||||
3. 派发 Developer Worker。
|
||||
4. 等待 `worker_done`。
|
||||
5. Product/Test 复测。
|
||||
6. 更新 `tasks.yaml`。
|
||||
7. 输出总结。
|
||||
|
||||
试运行结束后,检查是否出现以下问题:
|
||||
选一个低风险 bug 跑完整闭环,结束后检查是否出现:
|
||||
|
||||
- Developer 修改了越权路径。
|
||||
- worker_done 没有验证证据。
|
||||
- Product/Test 复测到了旧服务。
|
||||
- 任务板字段不够记录失败原因。
|
||||
- 三轮失败策略没有被执行。
|
||||
- 三轮失败策略没被执行。
|
||||
|
||||
把发现的问题回写到项目 `AGENTS.md` 或本工具包的项目副本中。
|
||||
把发现的问题回写到项目 `AGENTS.md`;若属通用问题,回流到 kit 的 `core/` 并升 `VERSION`。
|
||||
|
||||
Reference in New Issue
Block a user