pre-merge-checklist 是一个用于合并前就绪检查的技能,不负责代码逐行审查,后者应使用 diff review。它按步骤运行项目自身的命令并记录证据,最终生成报告。
用途:在合并当前分支前,检查构建、测试、lint、类型检查、改动范围、密钥与调试残留、迁移、配置、依赖、文档和 PR 描述等是否就绪。
主要能力:定位项目自己的命令(从 package.json scripts、Makefile、justfile、Taskfile.yml、Rakefile、pyproject.toml、tox.ini、noxfile.py、CI 配置、CONTRIBUTING.md 或 README 中查找,不发明命令);运行一组检查(分支是否最新、工作区是否干净、构建、测试、lint 与类型、改动范围、无密钥、无调试残留、迁移、配置与环境变量、依赖锁文件、文档与变更日志、描述);对新增行搜索密钥和调试残留;生成逐项报告。
使用方式:先记录构建、测试、lint 和类型检查命令,然后运行命令执行检查。使用 git merge-base 确定基线,用 git status、git diff、git log 检查分支状态和范围。密钥和调试残留搜索仅针对新增行,grep 行号指向 diff 而非文件,需打开每个命中项并报告真实文件:行号。许多命中可能是误报,需逐一核实。若命令需要数据库或网络等不可用服务,标记为“未运行”并说明原因,提供命令供用户自行运行。报告格式为每项检查一行,仅失败项附详情。
适用场景:开发者在合并分支前进行自动化就绪检查,尤其适合有明确构建、测试、lint 命令的项目。
限制:不评判代码质量;不修复问题,除非用户要求;无法运行的检查不能标记为通过;若项目有自有 PR 模板或清单,需同时使用并说明遵循的清单。