Git提交信息规范化
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @kunlungrowth/git-commit-msg。
技能介绍
解决什么问题
团队在多人协作时,git log 里经常混着 update、改bug、修复问题 这类模糊信息。时间一长,很难从提交历史中快速判断某次改动是为了新功能、缺陷修复还是重构,review、回滚和版本发布都缺少可靠依据。该技能用于把这些随意的描述统一成符合 Conventional Commits v1.0.0 的提交信息,让仓库历史更可读、可检索。
技能如何工作
使用时只需要提供一段自然语言变更描述,例如“修了登录页面密码验证的 Bug”。技能会按以下流程生成提交信息:
- 步骤 1:变更描述:从输入中提炼本次改动的对象和核心变化。
- 步骤 2:类型判断:从
feat、fix、docs、style、refactor、test、chore中选择最匹配的提交类型。 - 步骤 3:格式化:生成
type(scope): description结构的标题。 - 步骤 4:生成完整 message:输出可直接用于
git commit的标准化信息。
例如,输入“修了登录页面密码验证的 Bug。”会输出:fix(login): 修复密码验证逻辑错误。 技能输入是变更描述,输出是标准化提交信息。
适用边界与注意点
它不负责提交、推送或创建 Pull Request,只生成提交信息文本。如果一次变更同时包含多个不相关类型,建议拆成多个 Commit,而不是强行合并成一条信息。团队如果希望沿用现有提交风格,可以根据历史提交记录适配;面向严格 CI 校验时,仍需由仓库侧的 commitlint 或钩子做最终检查。
使用场景
- 个人开发完成后,面对多个修改文件,需要快速生成规范的 git commit 信息
- 团队协作时发现提交记录格式混乱,需要统一成员的 Commit 风格
- CI 流水线按提交类型触发部署,需要确保每次提交符合规范
- 代码回滚时需要快速定位某个功能是哪个提交引入的
适合人员
- 独立开发者:个人项目需要保持清晰的提交历史,便于日后回顾和版本管理
- 团队技术负责人:需要为团队制定并维护统一的 Git 提交规范
- 开源项目维护者:需要审查大量外部贡献者的提交,快速理解改动目的
- 新入职工程师:不熟悉团队现有的提交风格,需要快速上手生成规范信息