关于 pre-pr
pre-pr 是面向代码维护者的提交前检查技能,在改动完成后、创建 GitHub PR 前按项目模板整理变更、测试和证据;它根据改动涉及的层面指定验证与文档要求。
主要功能
- 01按 diff 分类变更
- 02识别所需测试与文档
- 03运行 lint、类型检查和测试
- 04收集 PR 证据
- 05填写 PR 描述模板
适用场景
- 01准备创建 GitHub PR
- 02确认改动所需的测试层级
- 03整理命令结果与行为证据
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ plastic-labs/ honcho --skill pre-pr安装后在 Claude Code 中输入/pre-pr确认已加载。
详细介绍
PR 前检查清单
更改生效后、有人创建 GitHub PR 之前执行此清单。输出一份已填写的模板正文——不要创建 PR。
模板位于 .github/pull_request_template.md。不要添加额外章节。
1. 对差异进行分类
git diff main...HEAD --stat
选择一个主要类型:bug、功能或文档。然后确定涉及的层:
| 涉及的部分 | 要求 |
|---|---|
src/(非提示词) | 在对应的 tests/ 目录树下编写单元测试 |
| deriver / dialectic / dreamer / LLM 路径 | 单元测试 + 考虑 live-llm(tests/live_llm) |
| 队列、配置层级、多轮交互、SDK 契约 | unified(uv run python -m tests.unified.run) |
/v3 HTTP 或 deriver 队列行为 | /verify 技能(运行时验证,而不只是 pytest) |
公共 API、SDK 导出、config.toml / 设置、mintlify docs/ | 在对应文件中编写文档 |
只有说明一行理由(例如“仅文档”“仅注释”)时,才可跳过某一层。“酌情处理”不算跳过理由。
运行时涉及的部分发生变化时,调用 /verify。不要在此处重复该技能的内容。
声称测试通过前,先运行 lint 和类型检查:uv run ruff check src/ → uv run basedpyright → 对应层的 pytest 命令。
2. 证明材料
收集应放入 PR 而非提交中的证据:
- 已运行命令及其通过/失败结果
- 能展示新行为的日志片段、截图或文件路径
- 对于 bug:如果有,提供修复前后的失败用例
如果运行了 /verify,其会话输出就是证明材料。不要捏造通过记录。
3. 编写正文
填写拉取请求描述模板中的说明和证明材料部分。
如果有相关的 GitHub issue,请使用 Fixes #<N> 链接。
评论
支持 Markdown