关于 pr-review
pr-review 是用于审查仓库中技能类 Pull Request 的技能,结合脚本结构校验与人工内容检查,涵盖质量指南和仓库规范。
主要功能
- 01校验技能文件与 YAML frontmatter
- 02检查必填字段及名称与目录匹配
- 03检测硬编码密钥
- 04审查范围、描述、脚本和文档
- 05区分阻断错误与提示项
适用场景
- 01合并前检查技能贡献
- 02查找缺失或格式错误的 SKILL.md 元数据
- 03审查 API 密钥处理和脚本质量
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ minimax-ai/ skills --skill pr-review安装后在 Claude Code 中输入/pr-review确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/quality-guidelines.mdstructure-rules.mdscripts/validate_skills.py详细介绍
PR 审查技能
根据仓库规范审查拉取请求。分为两个阶段:自动验证,然后手动审查内容。
阶段 1:自动验证(硬性规则)
运行验证脚本,检查结构要求:
python .claude/skills/pr-review/scripts/validate_skills.py
脚本会检查:
- 每个技能目录中是否存在
SKILL.md - YAML frontmatter 是否可解析
- 是否包含必填字段:
name、description name是否与目录名称一致- 是否检测到硬编码的密钥
所有 ERROR 级检查都必须通过。WARNING 级项目(缺少 license、metadata)应标记出来,但不构成阻塞。
完整的硬性规则规范请参阅 references/structure-rules.md。
阶段 2:内容审查(软性指南)
自动检查通过后,根据质量指南审查 PR:
- 技能范围 — 是否与现有技能重叠?边界是否清晰?
- 描述质量 —
description是否包含明确的触发条件? - 文件大小 — 参考文档的大小是否适合在上下文窗口中使用?
- API 密钥处理 — 如果使用外部 API,凭据是否从环境变量中读取?
- 脚本质量 — 脚本是否包含 shebang、requirements.txt 和错误处理?
- 语言 — SKILL.md 和代码是否使用英文编写?
- README 同步 — 新增技能时,是否更新了
README.md和README_zh.md?
软性指南详情请参阅 references/quality-guidelines.md。
审查清单摘要
必须通过(阻塞项)
-
validate_skills.py以代码 0 退出 - PR 标题遵循约定式提交格式
- 一个 PR,一个目的
应当通过(在审查中标记)
- 与现有技能不存在功能重叠
- 描述包含触发条件
- 文件大小合理
- API 密钥通过环境变量提供
- 为新增技能更新 README 表格(Source 列设为
Community)
评论
支持 Markdown