关于 code-review-checklist
用于生成贴合具体 Pull Request 的代码审查清单,并按优先级整理可执行检查项。它结合变更类型、编程语言和项目惯例,帮助审查者关注安全性、正确性与可维护性。
主要功能
- 01分析变更文件与类型
- 02应用语言专属检查
- 03考虑项目惯例
- 04优先排列可执行事项
- 05覆盖安全、性能、测试与可维护性
适用场景
- 01审查 Pull Request 前准备检查清单
- 02新成员入职时统一审查标准
- 03审查不熟悉的代码区域
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ curiositech/ some_claude_skills --skill code-review-checklist安装后在 Claude Code 中输入/code-review-checklist确认已加载。
附带文件.claude-plugin/plugin.json
详细介绍
代码审查清单生成器
生成全面且结合上下文的代码审查清单,帮助审查者针对每个特定 PR 聚焦最重要的事项。
使用时机
- 开始代码审查前,了解需要关注的事项
- 帮助新团队成员熟悉审查标准
- 确保团队审查质量一致
- 审查代码库中不熟悉的部分时
方法
- 分析差异:了解哪些文件发生了变化,以及变化的性质
- 识别模式:判断变更类型(功能、缺陷修复、重构等)
- 语言专属检查:应用适用于编程语言的相关检查
- 项目上下文:考虑代码库中的现有模式和约定
- 生成清单:生成按优先级排序、可执行的审查事项
清单类别
安全
- 存在输入验证
- 未硬编码机密或凭据
- 正确检查身份验证/授权
- 防止 SQL 注入
- Web 代码中防止 XSS
性能
- 不存在 N+1 查询模式
- 考虑了适当的缓存
- 没有不必要的循环或迭代
- 使用了高效的数据结构
可维护性
- 代码易读且自说明
- 函数大小适当
- 没有代码重复
- 命名约定一致
测试
- 单元测试覆盖了新功能
- 测试了边界情况
- 测试有实际意义,而非仅为提高覆盖率
最佳实践
- 优先处理安全问题
- 关注逻辑错误,而非吹毛求疵的风格问题
- 考虑审查者的时间——突出关键事项
- 根据项目成熟度调整清单
评论
支持 Markdown