关于 code-reviewer
Code Reviewer 是用于审查本地改动或远程 Pull Request 的 Agent 技能。它按正确性、可维护性、安全性等维度分析代码,并将反馈整理为问题和审查结论。
主要功能
- 01审查本地改动或远程 PR
- 02按七个维度检查代码
- 03整理问题和审查结论
- 04使用 GitHub CLI 检出远程 PR
适用场景
- 01审查已暂存和未暂存的改动
- 02评估 GitHub Pull Request
- 03查找安全或边缘情况问题
- 04建议批准或要求修改
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ google-gemini/ gemini-cli --skill code-reviewer安装后在 Claude Code 中输入/code-reviewer确认已加载。
详细介绍
代码审查员
此技能将指导 Agent 为本地开发和远程 Pull Request 进行专业、全面的代码审查。
工作流
1. 确定审查目标
- 远程 PR:如果用户提供了 PR 编号或 URL(例如“审查 PR #123”),则审查该远程 PR。
- 本地更改:如果用户没有提及特定 PR,或要求“审查我的更改”,则审查当前本地文件系统中的状态(已暂存和未暂存的更改)。
2. 准备工作
对于远程 PR:
- 检出:使用 GitHub CLI 检出该 PR。
gh pr checkout <PR_NUMBER> - 预检:运行项目的标准验证套件,尽早发现自动化检查失败。
npm run preflight - 背景信息:阅读 PR 描述和现有评论,了解目标和历史情况。
对于本地更改:
- 识别更改:
- 检查状态:
git status - 阅读差异:
git diff(工作区)和/或git diff --staged(已暂存)。
- 检查状态:
- 预检(可选):如果更改较多,可询问用户是否希望在审查前运行
npm run preflight。
3. 深入分析
根据以下要点分析代码更改:
- 正确性:代码是否在没有缺陷或逻辑错误的情况下实现了既定目的?
- 可维护性:代码是否整洁、结构清晰,且易于理解和修改?请考虑代码清晰度、模块化程度,以及是否遵循既有设计模式等因素。
- 可读性:代码是否在必要处有完善注释,并且按照项目的编码风格指南统一格式?
- 效率:更改是否引入了明显的性能瓶颈或资源利用低效问题?
- 安全性:是否存在潜在的安全漏洞或不安全的编码实践?
- 边界情况和错误处理:代码是否妥善处理了边界情况和潜在错误?
- 可测试性:新增或修改的代码是否有充分的测试覆盖(即使预检通过也应检查)?请建议可提升覆盖率或稳健性的其他测试用例。
4. 提供反馈
结构
- 摘要:对审查内容的高层概述。
- 发现:
- 严重问题:缺陷、安全问题或破坏性更改。
- 改进建议:提升代码质量或性能的建议。
- 小问题:格式或细微风格问题(可选)。
- 结论:给出明确建议(批准/请求修改)。
语气
- 保持建设性、专业且友善。
- 解释提出修改要求的原因。
- 对于批准的更改,肯定其具体贡献价值。
5. 清理(仅适用于远程 PR)
- 审查后,询问用户是否希望切回默认分支(例如
main或master)。
评论
支持 Markdown