code-review:给 AI 编程助手装上「标准化 Code Review 流程」

前言

Code Review 是软件开发里绕不开的一环。自己写的代码,往往越看越顺眼;同事提 PR 时,Reviewer 的反馈风格也因人而异——有人只盯安全,有人偏重可读性,有人习惯随手写两句「建议优化」就完事。把 AI 编程助手拉进审查流程之后,问题并没有自动消失:模型可能泛泛而谈,也可能每次输出的格式都不一样,团队很难把审查结论沉淀下来。

如果你已经在用 Cursor、Claude Code 或 GitHub Copilot 这类 AI 编程工具,其实可以借助 Agent Skill 机制,把「怎么审、审什么、怎么输出」写进一份 SKILL.md,让助手按固定流程干活。今天要介绍的 code-review,就是 awesome-agent-skills 仓库里自带的一个官方示例 Skill——结构简单、跨平台通用,非常适合作为「第一个 Code Review Skill」来体验。

这是什么

code-review 是一个智能代码审查 Skill,核心作用是:帮助 AI 评估代码质量、识别潜在问题,并按统一格式给出改进建议。

它出自 GitHub 上的 JackyST0/awesome-agent-skills 项目。该仓库专门收录适用于 Cursor、Claude Code、GitHub Copilot、Windsurf、OpenAI Codex 等工具的 Agent Skills,并在 examples/ 目录下提供了 5 个可直接使用的示例模板,code-review 就是其中之一。Skill 采用 CC0-1.0 许可,可自由复制和修改。

与「随口问一句帮我看看代码」不同,这个 Skill 在 SKILL.md 里写死了触发条件、审查步骤和输出模板。安装后,当你说「审查代码」「检查代码质量」「找问题」「要改进建议」之类的话,AI 会按 Skill 定义的流程走,而不是随意发挥。

核心功能与亮点

1. 明确的触发场景

Skill 在 When to Use 一节中规定了四类典型请求:

  • 审查代码
  • 检查代码质量
  • 寻找代码中的问题
  • 请求代码改进建议

中英文描述都有,便于在多语言环境下被 Agent 正确识别。

2. 五步审查流程

官方 SKILL.md 把审查过程拆成四个步骤(阅读 → 检查 → 建议 → 报告),检查维度覆盖:

维度 说明
语法错误 基础正确性
逻辑问题 边界条件、分支遗漏等
安全隐患 常见安全漏洞
性能问题 可优化的热点
代码风格 命名、格式、可读性

这比「让 AI 自由发挥」更可控,也更容易和团队现有的 Review 规范对齐。

3. 标准化输出报告

审查完成后,Skill 要求按固定 Markdown 模板输出,包含:

  • 概述(Summary):一段话总结
  • 发现的问题(Issues Found):带 checkbox 的问题清单
  • 改进建议(Suggestions):编号列表,每条可执行
  • 评分(Score):代码质量、可读性、可维护性三项,各 1–10 分

团队可以把这份报告直接贴进 PR 评论,或作为 Review 记录的起点。

4. 跨平台通用

Skill 基于通用的 SKILL.md 格式,同一份文件可以放到 Cursor、Claude Code、Copilot 等各平台的 Skills 目录中,无需为每个工具单独维护一套规则。

5. 自带完整示例

官方文档里给了一个 Python 小函数的输入输出示例,方便你安装后立刻验证 Skill 是否生效。

安装与启用

平台与目录对照

根据 awesome-agent-skills 官方文档,各平台的 Skills 目录如下:

平台 全局目录 项目目录
Cursor ~/.cursor/skills/ .cursor/skills/
Claude Code ~/.claude/skills/ .claude/skills/
GitHub Copilot ~/.copilot/skills/ .github/skills/
Windsurf ~/.windsurf/skills/ .windsurf/skills/
OpenAI Codex ~/.codex/skills/ .codex/skills/
OpenCode ~/.config/opencode/skills/ .opencode/skills/
OpenClaw ~/.openclaw/skills/ skills/

全局目录对所有项目生效;项目目录仅对当前仓库生效,且项目级 Skill 优先级更高,适合团队把审查规范提交到 Git 共享。

方式一:一键安装(推荐)

仓库提供了安装脚本,macOS / Linux 可直接执行:

# 交互式安装
curl -sL https://raw.githubusercontent.com/JackyST0/awesome-agent-skills/main/install.sh | bash

# 非交互:仅安装 code-review 到 Cursor
curl -sL https://raw.githubusercontent.com/JackyST0/awesome-agent-skills/main/install.sh | bash -s -- -p cursor -s code-review

-p 指定平台(cursor、claude、copilot、windsurf、codex 等),-s 指定 Skill 名称。Windows 用户可使用 PowerShell 版安装脚本:

irm https://raw.githubusercontent.com/JackyST0/awesome-agent-skills/main/install.ps1 | iex

方式二:手动安装

git clone https://github.com/JackyST0/awesome-agent-skills.git
cp -r awesome-agent-skills/examples/code-review ~/.cursor/skills/

以 Cursor 为例,安装完成后目录结构应类似:

~/.cursor/skills/code-review/
└── SKILL.md

方式三:项目级安装(Git 子模块)

若希望团队共用同一套审查规范,可在项目根目录执行:

mkdir -p .cursor/skills
cd .cursor/skills
git submodule add https://github.com/JackyST0/awesome-agent-skills.git
# 或只复制 examples/code-review 子目录到 .cursor/skills/code-review

验证安装

ls ~/.cursor/skills/code-review/SKILL.md

在 AI 对话中尝试:

请帮我审查这段代码的质量

若 Skill 被正确加载,回复应接近官方示例中的「代码审查报告」结构,而不是一段无格式的自由文本。

典型用法示例

官方示例:审查 Python 函数

输入代码:

def calc(x,y):
    return x+y

Skill 引导下的典型输出结构:

## 代码审查报告

### 概述
简单的加法函数,存在命名和格式问题。

### 发现的问题
- [ ] 函数名 `calc` 不具描述性
- [ ] 缺少类型提示
- [ ] 缺少文档字符串
- [ ] 运算符周围缺少空格

### 改进建议
1. 将函数重命名为 `add_numbers`
2. 添加类型提示:`def add_numbers(x: int, y: int) -> int:`
3. 添加 docstring 说明函数用途
4. 遵循 PEP 8 格式规范

### 评分
- 代码质量: 6/10
- 可读性: 7/10
- 可维护性: 5/10

实际使用中的几种写法

审查选中代码或粘贴片段:

请审查下面这段代码,重点看安全隐患和性能问题:

[粘贴代码]

结合 PR / diff 场景:

这是本次改动的 diff,请按 code-review 格式输出审查报告,并给出可维护性评分。

指定语言或规范:

请用 code-review skill 审查这段 Go 代码代码风格按项目里的 golangci-lint 配置来

你可以在 fork 后的 SKILL.md 里追加团队专属规则(例如必须检查 SQL 注入、必须对照内部 API 规范),项目级 Skill 会覆盖全局同名 Skill。

适用场景与注意事项

适合谁用

  • 个人开发者:提交前让 AI 按固定清单自检,减少低级问题。
  • 小团队:把 SKILL.md 放进仓库,统一 Review 输出格式。
  • 刚接触 Agent Skills 的读者:code-review 只有一份 SKILL.md,没有额外脚本依赖,适合理解 Skill 的基本结构后再扩展。

适合什么场景

  • 函数、模块级别的局部审查
  • 学习「好代码」与「需改进代码」的对照
  • 作为 PR Review 前的第一道 AI 预审

限制与注意

  1. 示例 Skill,非安全审计工具:官方定位是教学向示例,不能替代专业 SAST/DAST 或人工安全审计。
  2. 审查深度取决于模型与上下文:Skill 规定流程和格式,具体能发现多深的问题,仍与模型能力和提供的代码上下文有关。
  3. 安装后未生效时:检查目录名是否为 code-reviewSKILL.md 是否存在、文件权限是否正常,必要时重启 IDE。
  4. 与 parallel-code-review 等 Skill 的区别:社区里还有并行多 Agent 审查类 Skill;code-review 是单 Agent、轻量、标准化的入门版,二者可按需求组合使用。
  5. 可自由定制:CC0 许可下可复制到 .cursor/skills/code-review/ 后修改「检查维度」和「评分项」,使之贴合团队规范。

小结

code-review 把「怎么审代码、怎么写报告」写进一份通用的 SKILL.md,安装到 Cursor、Claude Code、Copilot 等工具后即可按需触发。它不追求替代人工 Review,而是给 AI 助手一条可重复、可沉淀的审查路径——对想规范 AI 辅助 Code Review 流程的开发者来说,是一个零依赖、易上手的起点。

官方仓库与 Skill 源码:

  • 项目主页:https://github.com/JackyST0/awesome-agent-skills
  • code-review 示例:https://github.com/JackyST0/awesome-agent-skills/tree/main/examples/code-review
  • 使用指南:https://github.com/JackyST0/awesome-agent-skills/blob/main/docs/how-to-use.md
羽毛球分组比赛记分
小程序二维码

欢迎使用《羽毛球分组比赛记分》微信小程序

小夜