pr-prep

自动准备PR,运行质量门禁并生成描述

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:pr-prep。
它的用途是:自动准备PR,运行质量门禁并生成描述
完整的 Skill 内容见:https://321skill.com/skills/pr-prep-x-2/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

'准备将feature-login分支合并到main,请自动运行质量门禁并生成PR描述。' 它会先执行代码检查(ESLint、Prettier)和单元测试,然后分析diff,生成包含改动摘要、影响范围、测试结果的PR描述,并保存到本地文件供提交。

介绍

pr-prep 是一款专注于提升 Pull Request 准备效率的自动化工具。它能在你提交代码前,自动运行预设的质量门禁(如代码检查、单元测试、安全扫描),并基于代码变更生成结构化的 PR 描述,包括改动摘要、影响范围、测试结果等,从而减少人工审查前的重复劳动,确保每次提交都符合团队规范。

使用方式非常简单:在本地开发环境中安装后,只需在合并分支前运行一条命令,或配置为 Git 钩子自动触发。工具会首先执行你定义的检查流程(如 ESLint、Prettier、Jest 等),然后分析 diff 内容,调用 LLM 生成符合团队模板的 PR 正文,并最终将结果写入本地或直接推送到远程仓库。

适合所有需要频繁提交代码的开发者,尤其是后端开发、全栈开发和测试工程师。项目经理也可以通过它统一团队的 PR 流程,减少人工审核的琐碎工作,提升代码合入效率。

建议根据项目实际需求,自定义质量门禁的检查项(如测试覆盖率阈值、代码规范规则),并定期更新 PR 描述模板以保持一致性。注意,该工具不替代人工代码评审,而是辅助准备阶段,让评审者能更快聚焦核心变更。

核心特点

与其他 PR 工具相比,pr-prep 将质量门禁执行、测试验证和描述生成三者串联为一个原子化流程,无需手动切换工具或复制粘贴结果,确保每次提交都经过完整的自动化检查并附带统一的描述。

注意事项

不适合需要大量人工判断的非标准化 PR(如重构遗留代码),或对描述格式有极高定制要求的场景。

常见问题

如何配置质量门禁的检查项?

在项目根目录创建 .pr-prep.config.js 文件,按文档示例配置 ESLint、Prettier、单元测试等检查命令和阈值。

生成的PR描述可以自定义模板吗?

可以,支持通过配置文件中的 template 字段指定 Markdown 模板,变量会自动填充。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/pr-prep-x-2/raw/index.md 读取 pr-prep 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。