用途:docs-check 是一个文档/变更日志检查点,确保文档卫生不被遗漏。它判断改动是否面向用户,并要求相应文档处理或显式豁免。
主要能力:将结果写入 .checkpoints/docs-check.json。采用启发式规则(v1):仅文档改动(仅 .md、.txt,或 .claude/、.claude-plugin/、docs/、plugins/ 下的文件)判定为 PASS;代码改动(其它任何文件)则要求满足其一:CHANGELOG.md 已更新,或在 issue 上带有显式豁免标签 no-changelog。豁免标签用于内部改动或重构等非面向用户的变更,使该决定显式且可检索。
使用方式:工作流分三步。第一步识别 Issue 与 Diff:提示中应给出 issue ID(如 TabzChrome-abc),用 git status --porcelain 判断,若干净则 git diff --name-only main...HEAD,否则优先暂存与未暂存改动 git diff --name-only 与 git diff --cached --name-only。第二步判定 PASS/FAIL:汇总改动文件并去重,按上述模式判断是否 CODE_CHANGED;若为代码改动,则检查 CHANGELOG.md 是否被修改,以及 issue 是否带 no-changelog 标签(通过 bd show "$ISSUE_ID" --json 与 jq 读取 labels)。满足 CHANGELOG_OK 或 BYPASS 即 PASS,否则 FAIL 并要求补充 CHANGELOG.md 条目或 no-changelog 标签。第三步写入检查点文件:mkdir -p .checkpoints,再以 cat 写入 .checkpoints/docs-check.json,包含 checkpoint、timestamp、passed、code_changed、changelog_updated、bypass_label、summary 字段。
适用场景:适合在提交或合并前作为文档卫生门禁,尤其需要区分面向用户改动与内部重构的仓库。
限制:资料仅提供 v1 启发式规则与上述命令,未说明支持平台、收费、价格或效果;具体集成方式与其它版本行为暂未提供。