✨ feat(templates): add sync templates scaffolding
This commit is contained in:
@@ -0,0 +1,129 @@
|
||||
# 需求澄清模板
|
||||
|
||||
## 何时使用
|
||||
|
||||
- 需求描述不明确
|
||||
- 存在多种理解方式
|
||||
- 缺少关键信息
|
||||
|
||||
---
|
||||
|
||||
## 澄清步骤
|
||||
|
||||
### 1. 理解当前需求
|
||||
|
||||
**复述需求**:
|
||||
|
||||
```text
|
||||
我理解你的需求是:[用自己的话复述]
|
||||
```
|
||||
|
||||
**识别歧义点**:
|
||||
|
||||
- 歧义 1:[描述不明确的地方]
|
||||
- 歧义 2:[可能有多种理解的地方]
|
||||
|
||||
---
|
||||
|
||||
### 2. 提出澄清问题
|
||||
|
||||
**问题模板**:
|
||||
|
||||
> 只问阻塞问题,最多 1–2 个;优先给出选项让用户选择。
|
||||
|
||||
#### 功能范围
|
||||
|
||||
- 这个功能是否包括 [场景 A]?
|
||||
- 是否需要支持 [边界情况 B]?
|
||||
- 优先级如何?必须有 vs 可选
|
||||
|
||||
#### 行为细节
|
||||
|
||||
- 当 [条件 X] 时,应该 [行为 Y] 还是 [行为 Z]?
|
||||
- 如果 [异常情况],如何处理?
|
||||
- 是否需要与 [现有功能] 保持一致?
|
||||
|
||||
#### 技术约束
|
||||
|
||||
- 是否有性能要求?
|
||||
- 是否有兼容性要求?
|
||||
- 是否有安全要求?
|
||||
|
||||
---
|
||||
|
||||
### 3. 提供选项
|
||||
|
||||
**选项格式**:
|
||||
|
||||
**选项 A**:[方案描述]
|
||||
|
||||
- 优点:[列出优点]
|
||||
- 缺点:[列出缺点]
|
||||
- 适用场景:[什么情况下选这个]
|
||||
|
||||
**选项 B**:[方案描述]
|
||||
|
||||
- 优点:[列出优点]
|
||||
- 缺点:[列出缺点]
|
||||
- 适用场景:[什么情况下选这个]
|
||||
|
||||
**推荐**:[推荐哪个选项,为什么]
|
||||
|
||||
---
|
||||
|
||||
### 4. 确认理解
|
||||
|
||||
**确认清单**:
|
||||
|
||||
- [ ] 功能范围明确
|
||||
- [ ] 行为细节清晰
|
||||
- [ ] 技术约束已知
|
||||
- [ ] 优先级确定
|
||||
- [ ] 验收标准明确
|
||||
|
||||
---
|
||||
|
||||
## 示例
|
||||
|
||||
### 需求
|
||||
|
||||
```text
|
||||
实现 XXX 功能
|
||||
```
|
||||
|
||||
### 澄清过程
|
||||
|
||||
**复述需求**:
|
||||
|
||||
```text
|
||||
我理解你的需求是:为 YYY 添加 XXX 功能,
|
||||
用于 ZZZ。
|
||||
```
|
||||
|
||||
**识别歧义点**:
|
||||
|
||||
- 歧义 1:XXX 是只读还是可写?
|
||||
- 歧义 2:是否需要支持所有场景?
|
||||
|
||||
**澄清问题**:
|
||||
|
||||
- 是否需要支持 [场景 A]?
|
||||
- 当 [条件 X] 时,应该如何处理?
|
||||
|
||||
**提供选项**:
|
||||
|
||||
**选项 A**:完整实现
|
||||
|
||||
- 优点:功能完整
|
||||
- 缺点:开发周期长
|
||||
|
||||
**选项 B**:核心功能
|
||||
|
||||
- 优点:快速交付
|
||||
- 缺点:功能有限
|
||||
|
||||
**推荐**:选项 A,因为 [原因]。
|
||||
|
||||
---
|
||||
|
||||
**最后更新**:{{DATE}}
|
||||
@@ -0,0 +1,94 @@
|
||||
# 验证检查清单
|
||||
|
||||
## 代码修改验证
|
||||
|
||||
### 语法检查
|
||||
|
||||
- [ ] 代码可正常运行(无语法错误)
|
||||
- [ ] 无未定义的变量或函数
|
||||
- [ ] 依赖引用正确
|
||||
|
||||
### 风格检查
|
||||
|
||||
- [ ] 命名符合规范
|
||||
- [ ] 缩进正确
|
||||
- [ ] 换行符正确(遵循 .gitattributes)
|
||||
- [ ] 无冗余注释
|
||||
|
||||
---
|
||||
|
||||
## 测试验证
|
||||
|
||||
### 单元测试
|
||||
|
||||
- [ ] 相关测试脚本存在
|
||||
- [ ] 测试可正常运行
|
||||
- [ ] 测试通过(无失败)
|
||||
|
||||
### 回归测试
|
||||
|
||||
- [ ] 现有测试仍然通过
|
||||
- [ ] 未破坏其他功能
|
||||
|
||||
---
|
||||
|
||||
## 文档验证
|
||||
|
||||
### 代码文档
|
||||
|
||||
- [ ] 复杂逻辑有注释说明
|
||||
- [ ] 公开 API 有使用示例(如需)
|
||||
|
||||
### 项目文档
|
||||
|
||||
- [ ] `memory-bank/progress.md` 已更新
|
||||
- [ ] 重要决策记录到 `memory-bank/decisions.md`
|
||||
- [ ] `CONFIRM.md` 中需讨论事项已记录
|
||||
|
||||
---
|
||||
|
||||
## Git 验证
|
||||
|
||||
### 提交前检查
|
||||
|
||||
- [ ] 只包含相关修改(无无关文件)
|
||||
- [ ] 提交信息清晰
|
||||
- [ ] 无临时文件或调试代码
|
||||
|
||||
### 分支检查
|
||||
|
||||
- [ ] 在正确的分支上工作
|
||||
|
||||
---
|
||||
|
||||
## 性能验证(如果涉及)
|
||||
|
||||
### 性能测试
|
||||
|
||||
- [ ] 处理时间可接受
|
||||
- [ ] 内存使用正常
|
||||
- [ ] 无明显性能退化
|
||||
|
||||
---
|
||||
|
||||
## 安全验证(如果涉及)
|
||||
|
||||
### 安全检查
|
||||
|
||||
- [ ] 无注入风险
|
||||
- [ ] 敏感信息已脱敏
|
||||
|
||||
---
|
||||
|
||||
## 快速检查清单(最小集)
|
||||
|
||||
**每次修改必须检查**:
|
||||
|
||||
- [ ] 代码可运行(无语法错误)
|
||||
- [ ] 相关测试通过
|
||||
- [ ] 换行符正确
|
||||
- [ ] `memory-bank/progress.md` 已更新
|
||||
|
||||
---
|
||||
|
||||
**最后更新**:{{DATE}}
|
||||
Reference in New Issue
Block a user