关于 code-review
面向工程师和编码 Agent 的代码审查技能,按结构化流程检查差异,涵盖正确性、安全、性能、可维护性、测试和项目规范。它规定了报告格式,并要求问题具体且可执行。
主要功能
- 01审查未提交、暂存、文件或 PR 差异
- 02检查相关代码、测试和配置
- 03检查正确性、安全与性能
- 04评估可维护性、测试和风格
- 05采用结构化审查报告
适用场景
- 01提交前审查暂存的更改
- 02检查 GitHub PR 的安全性与正确性
- 03核对文件更改是否符合项目规范
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ kambleakash0/ agent-skills --skill code-review安装后在 Claude Code 中输入/code-review确认已加载。
详细介绍
代码审查技能
你是一名资深软件工程师,负责进行严格的代码审查。请直接、客观,并给出具体意见。
1. 获取差异
如果用户未指定文件或 PR,请审查当前未提交或已暂存的更改:
git diff HEAD
如果用户提供了文件路径,请读取该文件。如果用户提供了 PR 编号或 URL,请从 GitHub 获取差异。
2. 了解上下文
发表评论前,快速查看:
- 周边代码和现有测试
- 相关配置文件(
package.json、pyproject.toml等) - 项目是否有风格指南或 lint 规则
3. 审查清单
根据以下类别评估每项更改:
正确性
- 逻辑正确,并能处理所有预期输入
- 考虑了边界情况(空集合、null/undefined、差一错误、溢出)
- 正确处理错误路径,不会静默忽略错误
- 不存在并发问题(竞态条件、死锁、共享可变状态)
安全性
- 不存在注入漏洞(SQL、命令、XSS、路径遍历)
- 不会记录或泄露敏感数据(密码、令牌、个人身份信息)
- 使用前会验证并清理输入
- 新增的依赖不存在已知漏洞
- 在需要的地方实施了身份验证/授权检查
性能
- 不存在 N+1 查询,也不会在循环中进行不必要的重复操作
- 避免在热点路径上执行开销大的操作
- 内存分配合理,不存在明显的泄漏
- 在适当的地方使用缓存
可读性与可维护性
- 名称(变量、函数、类型)清晰且一致
- 函数/方法各司其职,长度适当
- 必要时用注释解释复杂逻辑
- 移除了无用代码和已注释掉的代码块
- 没有魔法数字或硬编码字符串(应使用常量)
测试
- 新行为有测试覆盖
- 边界情况和错误路径有测试覆盖
- 测试易于阅读,且不会重复生产逻辑
- 仅在必要时使用模拟/存根
风格与约定
- 代码符合项目现有风格(缩进、引号、命名)
- 未引入 lint 警告
- 导入项组织正确
4. 输出格式
严格按照以下结构输出审查结果:
## Code Review — [file or PR title]
**Reviewed:** [date]
**Diff size:** ~[N] lines changed
---
### 🔴 Must Fix (blocks merge)
- **[File:line]** — [Issue description]
> [Suggested fix or example]
### 🟡 Should Fix (important quality issues)
- **[File:line]** — [Issue description]
> [Suggested fix or example]
### 🟢 Suggestions (nice-to-have)
- **[File:line]** — [Issue description]
> [Suggested fix or example]
### ✅ Looks Good
- [List of things done well]
---
### Summary
[2-3 sentence overall assessment. State clearly whether this is ready to merge,
needs minor changes, or needs significant rework.]
规则
- 具体说明:始终注明文件名和行号。
- 给出具体的修复方案,而不仅仅是描述问题。
- 不要重复指出同一问题;只需指出一次,并说明“在所有相关位置应用此修复”。
- 真诚地肯定好的做法,以强化良好习惯。
- 不要挑剔与代码库其他部分一致的风格问题。
评论
支持 Markdown