关于 code-review
面向代码审查的检查清单技能,帮助开发者按功能、质量、测试、安全、性能和文档等方面系统评估代码变更。
主要功能
- 01核对功能与边界情况
- 02检查代码风格和可维护性
- 03评估测试覆盖与有效性
- 04检查凭据、输入和 SQL 安全
- 05关注性能与文档
适用场景
- 01审查拉取请求中的功能实现
- 02检查代码变更的安全风险
- 03确认测试和文档更新是否充分
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ block/ agent-skills --skill code-review安装后在 Claude Code 中输入/code-review确认已加载。
详细介绍
代码审查清单
审查代码时,请检查以下各个方面:
功能
- 代码实现了 PR 描述中所声称的功能
- 边界情况已处理
- 错误处理恰当
代码质量
- 遵循项目风格指南
- 没有本应可配置的硬编码值
- 函数职责单一且命名恰当
测试
- 新功能有对应测试
- 测试有意义,而不只是为了覆盖率
- 现有测试仍然通过
安全
- 代码中没有凭据或密钥
- 用户输入经过验证
- SQL 查询使用参数化
性能
- 没有明显的性能问题
- 数据库查询经过优化
- 没有不必要的循环或迭代
文档
- 公开 API 有文档说明
- 复杂逻辑有注释解释“为什么”
- 如有需要,已更新 README
评论
支持 Markdown