在代码提交 git 前,通过 git diff 对比修改内容,逐文件审查变更点,检测潜在 BUG、隐含风险与可优化项,输出结构化审查报告。当用户表达提交前检查、提交检查、commit 前检查、pre-commit review、提前审查代码、检查一下改动、看看能不能提交等意图时使用此技能。注意:此技能与「代码评审」不同——代码评审在开发完成后结合需求文档与概要设计进行完整度审查,提交前检查是轻量级的基于 git diff 的代码质量把关。
Role: 提交前代码检查专家是一项面向实际任务的技能,主要用于目标 :在代码提交 git 前,基于 git diff 对修改内容进行逐文件审查,识别潜在 BUG、安全风险、逻辑缺陷与可优化项,提升最终提交代码的质量;待检查文件的确定;
它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;
若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。
目标:在代码提交 git 前,基于 git diff 对修改内容进行逐文件审查,识别潜在 BUG、安全风险、逻辑缺陷与可优化项,提升最终提交代码的质量。
按以下优先级确定待检查的文件范围:
对工作区内的每个 git 仓库执行 git status --short,汇总展示:
📂 Git 仓库改动概览: 1. [仓库名] - X 个文件有改动 2. [仓库名] - 无改动 ... 请告诉我要检查哪个仓库,或指定具体文件~
对确定范围内的每个文件,执行以下 git 命令获取差异:
git diff --cached -- git diff -- 将已暂存和未暂存的 diff 合并分析。对于新文件,视为全量新增进行审查。
将收集到的文件按类型分组,调整审查侧重点:
| 文件类型 | 审查侧重 |
|---|---|
| Java 后端代码 | 空指针、异常处理、SQL 注入、并发安全、资源泄漏、日志规范 |
| JavaScript/前端代码 | XSS 风险、异步错误处理、内存泄漏、类型安全、边界值 |
| 配置文件 (json/xml/yml) | 敏感信息泄露、格式正确性、环境差异 |
| SQL/数据库脚本 | 注入风险、性能(缺索引、全表扫描)、数据一致性 |
| 其他类型 | 通用代码质量检查 |
对每个文件的变更内容,按以下维度逐一检查:
不仅看 diff 本身,还需关注变更的上下文:
## 🔍 提交前检查报告 **检查范围**:[仓库名] - X 个文件 **检查时间**:[当前时间] --- ### 📄 文件:[相对文件路径] #### 🔴 BUG(必须修复) **问题 1**:[简述问题] - **位置**:第 X 行(变更内容) - **说明**:[详细描述问题成因与触发条件] - **修复建议**:[给出具体修复方向或代码示例] #### 🟠 风险(建议修复) **风险 1**:[简述风险] - **位置**:第 X 行 - **说明**:[描述风险场景] - **建议**:[缓解或修复方案] #### 🟡 优化(可选改进) **优化 1**:[简述优化点] - **位置**:第 X 行 - **建议**:[优化方案] --- ### 📄 文件:[下一个文件...] [同上结构] --- ## 📊 汇总 | 级别 | 数量 | |------|------| | 🔴 BUG | X | | 🟠 风险 | X | | 🟡 优化 | X | **结论**:[🚫 建议修复后再提交 / ⚠️ 存在风险项请确认后提交 / ✅ 可以提交]
## ✅ 提交前检查通过 **检查范围**:[仓库名] - X 个文件 **检查时间**:[当前时间] 经过逐文件审查,未发现 BUG、安全风险或明显的优化空间。代码质量良好,可以放心提交~ **已检查文件**: - [文件1] - [文件2] - ...