prototype generated
This commit is contained in:
@@ -0,0 +1,41 @@
|
||||
# 领域文档
|
||||
|
||||
本文件说明工程技能在分析和修改仓库前,应如何读取领域文档。
|
||||
|
||||
## 开始分析前
|
||||
|
||||
按需读取:
|
||||
|
||||
- 根目录的 `CONTEXT.md`
|
||||
- 如果将来出现 `CONTEXT-MAP.md`,由它定位当前主题对应的领域上下文
|
||||
- `docs/adr/` 中与当前修改相关的架构决策记录
|
||||
|
||||
文件不存在时静默继续,不需要预先创建空文件。领域词汇和架构决策应在实际形成结论时按需补充。
|
||||
|
||||
## 当前布局
|
||||
|
||||
本仓库采用单上下文结构:
|
||||
|
||||
```text
|
||||
/
|
||||
├── CONTEXT.md
|
||||
└── docs/
|
||||
└── adr/
|
||||
```
|
||||
|
||||
`CONTEXT.md` 只保存领域术语和统一语言;`docs/adr/` 保存具有长期影响的架构决策。
|
||||
|
||||
## 使用统一领域语言
|
||||
|
||||
Issue 标题、规格、重构建议、测试名称和实现说明应使用 `CONTEXT.md` 中定义的术语,不应改用其中明确要求避免的同义词。
|
||||
|
||||
如果需要使用的概念尚未出现在词汇表中,应先判断:
|
||||
|
||||
1. 是否正在引入项目并不存在的新术语;
|
||||
2. 是否确实发现领域词汇缺口。
|
||||
|
||||
真实的领域词汇缺口应通过领域建模流程补充。
|
||||
|
||||
## 发现 ADR 冲突时
|
||||
|
||||
如果计划或实现与现有 ADR 冲突,必须明确指出冲突及理由,不得静默覆盖既有决策。
|
||||
@@ -0,0 +1,32 @@
|
||||
# Issue tracker:本地 Markdown
|
||||
|
||||
本仓库的需求、规格和实施任务使用 `.scratch/` 下的 Markdown 文件管理。
|
||||
|
||||
## 约定
|
||||
|
||||
- 每个功能使用独立目录:`.scratch/<feature-slug>/`
|
||||
- 功能规格为:`.scratch/<feature-slug>/spec.md`
|
||||
- 实施任务存放于:`.scratch/<feature-slug>/issues/<NN>-<slug>.md`
|
||||
- 任务从 `01` 开始编号,每个任务使用独立文件,不创建合并的 tickets 文件
|
||||
- Triage 状态记录在任务文件顶部附近的 `Status:` 行
|
||||
- 评论和讨论记录追加到文件底部的 `## Comments` 小节
|
||||
|
||||
## 发布到 Issue Tracker
|
||||
|
||||
当技能要求“发布到 Issue Tracker”时,在 `.scratch/<feature-slug>/` 下创建对应文件;目录不存在时可以创建。
|
||||
|
||||
## 获取任务
|
||||
|
||||
当技能要求获取相关任务时,读取用户提供的任务路径或任务编号对应的文件。
|
||||
|
||||
## Wayfinding 约定
|
||||
|
||||
- 地图:`.scratch/<effort>/map.md`
|
||||
- 子任务:`.scratch/<effort>/issues/NN-<slug>.md`
|
||||
- 子任务通过 `Type:` 记录类型:`research`、`prototype`、`grilling` 或 `task`
|
||||
- 子任务通过 `Status:` 记录 `claimed` 或 `resolved`
|
||||
- 依赖关系使用 `Blocked by: NN, NN`
|
||||
- 所有依赖任务为 `resolved` 后,当前任务才解除阻塞
|
||||
- 可执行任务按编号顺序领取
|
||||
- 领取时先将状态设为 `claimed` 并保存
|
||||
- 完成时在 `## Answer` 下记录结果,将状态改为 `resolved`,并向 `map.md` 的 Decisions-so-far 添加摘要和链接
|
||||
@@ -0,0 +1,13 @@
|
||||
# Triage Labels
|
||||
|
||||
工程技能使用五类标准 triage 角色。本文件记录标准角色与本仓库实际状态字符串的对应关系。
|
||||
|
||||
| 标准角色 | 本仓库状态 | 含义 |
|
||||
| --- | --- | --- |
|
||||
| `needs-triage` | `needs-triage` | 等待维护者评估 |
|
||||
| `needs-info` | `needs-info` | 等待报告人补充信息 |
|
||||
| `ready-for-agent` | `ready-for-agent` | 需求完整,可由智能体独立实施 |
|
||||
| `ready-for-human` | `ready-for-human` | 需要人工实施或决策 |
|
||||
| `wontfix` | `wontfix` | 确定不处理 |
|
||||
|
||||
当技能使用某类 triage 角色时,应采用本表右侧对应的状态字符串。
|
||||
Reference in New Issue
Block a user