DSH VERTICAL KIT · PR 描述检查 / 拉取请求描述检查
PR 描述检查清单
它决定一件事:这条 PR 描述是否给了 reviewer 能动手的 what / why / how-verified。
检查规则
| 规则 | 判定 |
|---|---|
empty | 描述为空 → error |
what-missing | 没有「做了什么」段 → error |
why-missing | 没有「为什么」段 → error(diff 说明改了什么,改不了理由) |
test-missing | 没有测试/验证说明 → error(等于让 reviewer 替你验) |
issue-unlinked / issue-missing | 没关联 issue → warn(--require-issue 时升级 error) |
breaking-without-migration | 提到破坏性变更但没有迁移说明 → error |
checklist-unchecked | 检查项一个都没勾 → warn |
用法
npx pr-description-check body.md --jsongh pr view 42 --json body --jq .body | npx pr-description-check -
真实输入输出
输入
修了点东西$ pr-description-check pr-sample.md
error what-missing 第0行 没有「做了什么」段(认得:## 概述、## 变更、这个 PR…)——reviewer 只能从 diff 反推意图
error why-missing 第0行 没有「为什么」段(认得:## 背景、## 动机、因为…)——diff 说明改了什么,改不了改的理由
error test-missing 第0行 没有测试/验证说明(认得:## 测试、验证:…、How tested)——没有验证说明的 PR 让 reviewer 替你验证
warn issue-unlinked 第0行 没有关联 issue(认得:Fixes #12、#56)——小改动可以没有,但追溯性会差一些
fail: 0 checkboxes, 3 errors, 1 warnings
出口码:1。输出为真实 CLI 运行的逐字结果,由测试与工具保持同步。
出口码:0 干净、1 有发现、2 用法或读文件错误。--json 输出机器可读结果。DSH 内同样的函数在 POST /pr-description-check/api({"text":"…"} 或 {"path":"…"}),面板与 CI 调同一实现。
这是清单,不是专业人士。合同检查不是法律意见,发票检查不判税务合规,listing 检查不判商业价值。每条发现都是文本里可判定的结构缺陷,带行号。
只验描述的形状,不验内容真假:它看不出概述写的是另一个改动、测试声明是编的、issue 链接指向无关的东西。它验证文本以 reviewer 能动手的形式回答了 what/why/how-verified;答案是否诚实,是评审和 CI 的事——试图裁判诚实的工具只能靠猜。 · dsh-vertical-kit · 通用检查(哈希/引用/结构/表格/数字)在 dsh-verify-kit