代码审查助手
语言: English | 简体中文
使用标准化的检查清单和评论前缀,执行系统性的代码审查。
工作流程
- 识别变更 - 通过
git diff或git show取得待审查文件的差异 - 套用检查清单 - 系统性地检查每个审查类别
- 产生报告 - 使用标准评论前缀输出发现
- 总结 - 提供整体评估和建议的后续行动
审查类别
- 功能性 - 功能是否正确? | Does it work correctly?
- 设计 - 架构是否合适? | Is the architecture appropriate?
- 品质 - 代码是否干净可维护? | Is the code clean and maintainable?
- 可读性 - 是否容易理解? | Is it easy to understand?
- 测试 - 测试覆盖是否足够? | Is there adequate test coverage?
- 安全性 - 是否有安全漏洞? | Are there any vulnerabilities?
- 性能 - 是否有效率? | Is it efficient?
- 错误处理 - 错误处理是否妥当? | Are errors handled properly?
评论前缀
| 前缀 | 意义 | 动作 | Action |
|---|---|---|---|
| BLOCKING | 必须在合并前修复 | 必须修复 | Required |
| IMPORTANT | 应该修复 | 建议修复 | Recommended |
| SUGGESTION | 锦上添花 | 可选改善 | Optional |
| QUESTION | 需要说明 | 需要讨论 | Discuss |
| NOTE | 信息性 | 仅供参考 | FYI |
使用方式
/code-review- 审查目前分支的所有变更/code-review src/auth.js- 审查特定文件/code-review feature/login- 审查特定分支
下一步引导
/code-review 完成后,AI 助手应建议:
代码审查完成。建议下一步:
- 有 ❗ BLOCKING 项目 → 修复后重新执行
/code-review- 全部通过 → 执行
/checkin品质关卡- 仅有 💡 SUGGESTION → 执行
/commit提交变更- 审查中发现规范不实用或缺失 → 执行
/audit --report回报
参考
- Pre-Commit Checklist(提交前检查清单) — 提交之前当作最后一道检查时读它。
- 详细指南:guide.md
- 核心规范:code-review-checklist.md