cenmiao/openspec-sp-code-review

Code Review Skill

核心原则：Review early, review often.

---

审查触发时机

必须审查的节点

• 每个逻辑任务完成后
• 准备合并代码前
• 重大重构后
• 实现关键功能后

---

审查清单维度

1. Plan Alignment（计划一致性）

• [ ] 实现是否符合原计划/架构/需求？
• [ ] 是否有偏离设计决策？
• [ ] 如有偏离，是否合理且有记录？

2. Code Quality（代码质量）

• [ ] 错误处理是否充分？
• [ ] 类型安全是否保证？
• [ ] 是否采用防御式编程？
• [ ] 代码组织是否清晰？
• [ ] 命名是否一致且有意义的？
• [ ] 可维护性如何？

3. Architecture（架构）

• [ ] 是否遵循 SOLID 原则？
• [ ] 是否使用合适的设计模式？
• [ ] 模块间是否松耦合？
• [ ] 可扩展性如何？
• [ ] 是否与现有系统集成良好？

4. Documentation（文档）

• [ ] 是否有适当的注释？
• [ ] 函数/类是否有文档？
• [ ] 文件头信息是否准确？
• [ ] 是否符合项目文档规范？

5. Testing（测试）

• [ ] 测试覆盖是否充分？
• [ ] 测试质量如何？
• [ ] 是否有边界条件测试？
• [ ] 是否有集成测试？

6. Security（安全）

• [ ] 是否有潜在安全漏洞？
• [ ] 输入验证是否充分？
• [ ] 是否有注入风险？
• [ ] 敏感数据处理是否安全？

7. Performance（性能）

• [ ] 是否有性能问题？
• [ ] 是否有不必要的复杂度？
• [ ] 是否有优化空间？

---

问题分类

Critical（必须修复）

阻止合并的严重问题：

• 安全漏洞
• 功能缺陷
• 严重性能问题
• 数据损坏风险

Important（应该修复）

应该修复但不阻止合并：

• 代码质量问题
• 测试覆盖不足
• 文档缺失

Suggestions（建议改进）

可选的改进建议：

• 代码风格优化
• 命名改进
• 重构机会

---

审查输出格式

## Code Review: <file/change>

### Summary
简要概述审查结果

### Critical Issues（必须修复）
1. **问题描述**
   - 位置：`file.ts:123`
   - 影响：...
   - 建议：...

### Important Issues（应该修复）
1. **问题描述**
   - 位置：`file.ts:456`
   - 建议：...

### Suggestions（建议改进）
1. **问题描述**
   - 建议：...

### What Was Done Well
- ...

---

审查流程

┌─────────────────────────────────────────────────────────┐
│  Code Review Process                                    │
├─────────────────────────────────────────────────────────┤
│                                                         │
│  1. 准备阶段                                            │
│     - 确定审查范围                                     │
│     - 准备审查清单                                     │
│                                                         │
│  2. 审查阶段                                            │
│     - 按维度检查                                       │
│     - 记录问题                                         │
│                                                         │
│  3. 分类阶段                                            │
│     - Critical / Important / Suggestion                │
│                                                         │
│  4. 输出阶段                                            │
│     - 结构化报告                                       │
│     - 具体建议                                         │
│                                                         │
│  5. 跟进阶段                                            │
│     - 确认修复                                         │
│     - 重新审查（如需要）                               │
│                                                         │
└─────────────────────────────────────────────────────────┘

---

使用示例

用户：我完成了用户认证模块的实现

助手：我使用 openspec-sp-code-review 技能来审查代码。

**审查范围**: 用户认证模块
**审查维度**: Plan Alignment, Code Quality, Architecture, Documentation, Testing, Security, Performance

**审查结果:**

### Critical Issues
[无]

### Important Issues
1. **缺少密码强度验证**
   - 位置：`auth.service.ts:45`
   - 建议：添加密码强度检查

### Suggestions
1. **命名可以更具描述性**
   - `handleLogin` → `authenticateUserWithCredentials`

**后续步骤**: 修复 Important 问题后重新审查

---

与其他技能集成

• openspec-sp-subagent-dev: 两阶段审查后的最终完整审查
• openspec-verify-change: 验证阶段的审查
• openspec-apply-change: 任务完成后的审查