用途:在运行 gh pr create 之前、实现完成待评审时,或为缺少必要章节的已有 PR 补充描述时使用,帮助按 OpenMetadata 仓库的 .github/pull_request_template.md 逐节填写 PR 描述。
主要能力:走查模板各节并收集证据,生成完整 PR 描述;根据 diff 自动分类变更(UI、后端接口、ingestion、大改动等),判断哪些章节必填;在创建 PR 前执行质量门禁,缺失项会拒绝开 PR 并提示用户。
必要章节:关联 issue(Fixes #编号,无 issue 需先创建)、变更类型(仅勾选一项)、高层设计(大 PR 必填,小修复可跳过)、测试(用例、单测与覆盖率、后端集成测试、ingestion 集成测试、Playwright UI 测试、手动步骤)、UI 录屏或截图(UI 变更必填)、检查清单(每项勾选或明确 N/A)。
用法:/pr-checklist 走查当前分支与 origin/main;/pr-checklist feature-branch 指定分支;/pr-checklist 12345 更新已有 PR 描述。流程包括检查变更、确认 issue、收集测试证据、整理手动步骤、UI 录屏、起草正文、创建或更新 PR。
限制:仅面向 OpenMetadata 仓库;测试覆盖率等数据必须实际运行工具获取,不得编造;UI 变更未附录屏时需标记 TODO 并以草稿方式开 PR;资料未提供其他平台或收费信息。