GI Git Commit Helper

通过分析git diff生成描述性提交信息,用于帮助用户编写提交信息或审查暂存变更。

安装

概览

什么是GI Git Commit Helper

GI Git Commit Helper 是一款专为开发者设计的 Git 提交信息生成工具,旨在通过智能分析代码变更内容,自动生成符合 Conventional Commits 规范的提交消息。该工具能够自动解析 `git diff` 输出,识别新增、修改或删除的代码文件,并基于变更类型(如功能新增、Bug 修复、文档更新等)推荐合适的提交类型和范围描述。用户只需运行简单的命令或调用接口,即可快速获得结构清晰、语义明确的提交信息,极大提升团队协作中提交日志的可读性与一致性。无论是日常开发中的小改动,还是复杂模块的重构,GI Git Commit Helper 都能帮助开发者规范提交行为,减少手动编写错误,提高版本控制效率。

核心功能特点

  1. 基于 git diff 自动分析代码变更内容,识别新增、修改和删除的文件
  2. 遵循 Conventional Commits 规范生成标准格式的提交信息
  3. 支持多种提交类型(feat、fix、docs、refactor 等)和范围标识(如 api、service、component)
  4. 提供中英文可选的主题描述,适应不同团队语言习惯
  5. 可输出简洁的 subject 和可选的详细 body,便于后续审查与追踪

适用场景

GI Git Commit Helper 特别适合在需要频繁提交代码的团队开发环境中使用。当开发者完成一个新功能模块的开发后,可以通过该工具快速生成类似 `feat(auth): add JWT login endpoint` 的提交信息,确保提交记录清晰反映变更意图。对于修复线上 Bug 的场景,工具能自动识别涉及的业务逻辑层(如 service 或 dao),并生成如 `fix(reports): correct date timezone in report generation` 的精准描述,方便后续问题回溯。在重构项目结构时,例如将订单服务中的支付逻辑拆分到独立模块,开发者也可借助工具生成 `refactor(service): extract payment logic from order service` 这类明确表达重构目的的提交信息。此外,当依赖项升级或构建配置调整时,使用 `chore(deps): upgrade vue to 3.4.x` 形式的提交能有效区分常规开发与运维类操作,维护仓库历史记录的整洁性。无论是前端组件优化还是后端 API 迭代,该工具都能显著提升提交信息的标准化程度。