工程开发
generate-commit-message avatar

generate-commit-message

根据暂存区的变更,生成结构化且符合规范的 git 提交信息。

简介

generate-commit-message 技能是一款专为软件工程师设计的自动化工具,旨在通过确保提交历史的标准化与描述性来简化版本控制工作流程。该工具通过直接与 Git 暂存区整合,分析当前的差异(排除不相关的元数据),进而合成关于代码变更的易读摘要。它严格遵循 Conventional Commits 规范,强制执行包括类型、可选作用域及简洁祈使句描述的结构。这有助于维持清晰且易于浏览的提交历史,这对于长期项目维护与自动化变更日志生成至关重要。

  • 使用 git --no-pager diff 指令自动捕获暂存区的代码变更进行处理。

  • 强制执行 Conventional Commits 标准,支持 feat、fix、docs、style、refactor、perf、test、build 与 ci 等类型。

  • 将提交信息标题限制在 50 个字符以内,以确保在终端日志与 git 图形界面中的可读性。

  • 要求描述语句采用祈使语气,以确保意图沟通明确。

  • 减少开发人员在维护复杂仓库并需快速记录增量变更时的手动负担。

  • 主要输入为本地 git 仓库中暂存的变更集,输出为一段纯文本的提交信息。

  • 在调用代理程序之前,请务必正确暂存文件 (git add),以确保差异分析的准确性。

  • 该工具会忽略 diff 输出中的颜色信息以防止解析错误,并确保无论终端主题设置如何都能保持一致。

  • 虽然工具会根据内容建议信息,但其设计初衷是为了提升效率;在产生之前,请确保差异内容准确反映了变更背景。

  • 限制条件包括最大字符数与固定格式,这确保了与 CI/CD 流水线及自动化发布工具的兼容性。

仓库统计

Star 数
0
Fork 数
0
Open Issue 数
0
主要语言
Lua
默认分支
main
同步状态
空闲
最近同步时间
2026年5月3日 22:00
在 GitHub 查看