关于 code-review
code-review 是一项指导代码变更审查的技能,涵盖缺陷、设计、测试、安全和长期风险。它还规定了可执行且体谅的反馈方式,并强调以风险为依据进行审批。
主要功能
- 01检查运行时与性能风险
- 02评估副作用和兼容性
- 03审查安全问题与 ORM 查询
- 04评估设计和测试覆盖
- 05标记需资深工程师审查的变更
适用场景
- 01检查拉取请求中的安全漏洞
- 02评估关键路径和边界情况的测试
- 03识别数据库结构或 API 变更风险
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ millionco/ expect --skill code-review安装后在 Claude Code 中输入/code-review确认已加载。
详细介绍
代码审查
审查代码时请遵循以下指南。
审查清单
识别问题
留意代码变更中的以下问题:
- 运行时错误:潜在异常、空指针问题、越界访问
- 性能:无界 O(n²) 操作、N+1 查询、不必要的内存分配
- 副作用:影响其他组件的意外行为变更
- 向后兼容性:没有迁移路径的破坏性 API 变更
- ORM 查询:可能导致查询性能异常的复杂 Django ORM
- 安全漏洞:注入、XSS、访问控制缺失、机密信息泄露
设计评估
- 组件之间的交互是否合乎逻辑?
- 变更是否符合项目现有架构?
- 是否与当前需求或目标冲突?
测试覆盖率
每个 PR 都应有适当的测试覆盖:
- 针对业务逻辑的功能测试
- 针对组件交互的集成测试
- 针对关键用户流程的端到端测试
确认测试覆盖了实际需求和边缘情况。避免在测试代码中使用过多分支或循环。
长期影响
以下变更应提交资深工程师审查:
- 数据库架构修改
- API 契约变更
- 采用新的框架或库
- 性能关键代码路径
- 安全敏感功能
反馈指南
语气
- 保持礼貌并体谅他人
- 提出可执行的建议,而非含糊的批评
- 不确定时以问题的形式表达:“您是否考虑过……?”
批准
- 仅剩轻微问题时批准
- 不要因风格偏好而阻止 PR
- 请记住:目标是降低风险,而不是追求完美代码
评论
支持 Markdown