quality-gate

Files (1)

• SKILL.md

SKILL.md (first lines)

# quality-gate

提交审查前的自查门。作者在发给其他猫审查之前，先自己检查一遍。

## 何时使用

- 完成一个代码变更后
- 发起审查请求（`request-review`，由作者自行发起）之前（前置条件）
- 对已有代码做改动后自查

## 不使用的情况

- 纯对话/回答用户问题（无代码变更）
- 探索/调研阶段
- 已经在审查循环中（receive-review 处理后）

## 检查步骤

### 步骤 1：VISION CHECK（需求对齐）

回到原始需求和讨论，确认：

- [ ] 改动实现了用户/任务要求的所有功能
- [ ] 没有范围蔓延（多做了不相关的改动）
- [ ] 如果有 .pen 设计文件，与实现做视觉对比

### 步骤 2：CODING STANDARDS CHECK（编码规范）

对照 `CODING_STANDARDS.md`（项目根目录）逐项检查：

- [ ] 包结构：代码放在正确的 monorepo 包中
- [ ] TypeScript：无 `any`，Zod 校验覆盖 API 边界，命名转换正确
- [ ] 测试：测试通过，覆盖新增/修改的功能
- [ ] 命名：文件 kebab-case，组件 PascalCase，函数 camelCase
- [ ] 错误处理：非阻塞降级、超时保护、结构化日志
- [ ] Vue：scoped 样式、v-html 经 DOMPurify
- [ ] 数据库：幂等迁移、JSON 字段处理、WAL 模式

### 步骤 3：TEST EVIDENCE（测试证据）

```bash
pnpm test
pnpm lint
```

确认：

- [ ] 所有测试通过
- [ ] 无新增 lint 错误
- [ ] 测试覆盖了新功能的关键路径

### 步骤 4：ARCHITECTURE BOUNDARY（架构边界）

- [ ] 依赖方向正确（shared ← server ← web）
- [ ] 无跨包直接引用（server 不 import web 代码）
- [ ] 新文件位置合理
- [ ] 如有新依赖，已声明并获批准

### 步骤 5：SECURITY SWEEP（安全扫描）

- [ ] 无硬编码的密钥/Token/密码
- [ ] `v-html` 已通过 DOMPurify 消毒
- [ ] API 输入有 Zod 校验
- [ ] 无 `eval()`、`new Function()`、`innerHTML` 裸赋值
- [ ] SQL 查询使用参数化（无字符串拼接）

### 步骤 6：UNFINISHED BUSINESS（未完成项扫描）

- [ ] 无 TODO/FIXME/HACK 注释（或已明确标记为有意保留）
- [ ] 无被注释掉的代码块
- [ ] 无 `console.log` 调试语句
- [ ] 无 `only`/`skip` 标记的测试（`test.only`、`it.skip`）

### 步骤 7：SELF-DOGFOOD（自测）

如果是用户可见的功能变更：

- [ ] 启动应用（`pnpm dev`）验证功能正常工作
- [ ] 至少走通一条完整的用户路径

### 步骤 8：TWO-AXIS SELF-CHECK（双轴自查，code-review 方法论）

code-review 把审查拆成两条独立轴，自查同样过两轴——**一条轴过了不代表另一条**：

- **Standards 轴**：代码是否符合项目文档化编码规范（CODING_STANDARDS.md）？
- **Spec 轴**：代码是否忠实实现发起它的 spec/issue/需求（无缺失、无范围蔓延）？

两轴分开核对，别在「代码很干净」的满足感里跳过 Spec 轴的逐条需求对齐；也别在「需求都对上了」里跳过规范检查。

### 步骤 9：SMELL SWEEP（坏味道扫描，Fowler 基线）

对照 code-review 的 smell baseline 扫自己的 diff（文档化规范优先于基线；每条是判断标签不是硬违规；工具已强制的跳过）：

- Mysterious Name / Duplicated Code / Feature Envy / Data Clumps / Primitive Obsession
- Repeated Switches / Shotgun Surgery / Divergent Change / Speculative Generality
- Message Chains / Middle Man / Refused Bequest

命中 → Gate 报告列出，能当场修就修；不能修 → 作为 Open Question 点名具体文件/符号给审查者。

## 输出

自查通过后，输出以下格式：

```
## Quality Gate Report

### Vision Check
✅ 所有需求已实现 / ⚠️ 以下需求未覆盖：...

### Standards Check
✅ 通过 / ❌ 以下项目未通过：...

### Test Evidence
pnpm test → N passed, 0 failed
pnpm lint → 通过 / M errors

### Architecture
✅ 边界正确 / ❌ 以下问题：...

From JianHun101/catStudio, MIT.

More from JianHun101/catStudio