51 lines
1.6 KiB
Markdown
51 lines
1.6 KiB
Markdown
---
|
||
name: review-checklist
|
||
description: 项目级代码评审检查清单。按项目积累特定检查项，挂载在 dev-review 下自动加载。每次 CR 时触发。
|
||
---
|
||
|
||
# 代码评审检查清单插件 (review-checklist)
|
||
|
||
## 概述
|
||
|
||
本插件为 `dev-review` 提供**项目特定的检查清单**，补充五视角扫描法之外的项目级经验。
|
||
|
||
检查清单按项目独立维护，每个项目文件记录该项目踩过的坑和必查项。
|
||
|
||
## 使用方式
|
||
|
||
1. `dev-review` 执行五视角扫描时，先读取 `references/general.md`
|
||
2. 如果仓库是 AI-Proj，读取 `references/ai-proj.md`；如果是 Coolbuy PaaS，读取 `references/coolbuy-paas.md`
|
||
3. 扫描完成后，逐条检查适用的清单项
|
||
4. 检查结果附加到 CR 报告的「项目检查清单」章节
|
||
|
||
## 检查清单文件
|
||
|
||
```
|
||
review-checklist/
|
||
├── SKILL.md # 本文件
|
||
└── references/
|
||
├── ai-proj.md # AI-Proj 项目清单
|
||
├── coolbuy-paas.md # 酷采3.0 项目清单
|
||
└── general.md # 通用清单（所有项目适用）
|
||
```
|
||
|
||
## 如何添加检查项
|
||
|
||
当 CR 中发现了一个**项目特有**的问题模式，且未来可能复发时：
|
||
|
||
1. 打开 `references/` 中对应项目的检查清单文件
|
||
2. 添加条目，格式：`- [ ] {检查项} — 教训：{来源}`
|
||
3. 标注严重度和适用范围
|
||
|
||
**不要添加**五视角扫描已覆盖的通用安全/并发/边界问题。
|
||
|
||
## CR 报告附加章节
|
||
|
||
```markdown
|
||
### 项目检查清单（{项目名}）
|
||
|
||
| # | 检查项 | 结果 | 说明 |
|
||
|---|--------|------|------|
|
||
| 1 | {检查项} | ✅/❌/N/A | {说明} |
|
||
```
|