Git 提交信息生成器

免费在线 Git 提交信息生成器,遵循约定式提交(Conventional Commits)格式。通过类型、作用域、描述、正文、破坏性变更和页脚字段构建结构化的提交信息。

...

什么是 Git 提交信息生成器?

Git 提交信息生成器帮助开发者按照约定式提交规范编写结构良好的提交信息。约定式提交提供了一种标准化格式——type(scope): description——使提交历史更具可读性,支持使用 semantic-release 等工具实现自动化版本管理,并简化变更日志的生成。本工具引导您逐步填写提交信息的各个部分,确保项目中的提交风格一致。

如何使用 Git 提交信息生成器

  1. 从下拉列表中选择提交类型(feat、fix、docs、style、refactor、perf、test、build、ci、chore 或 revert)。
  2. 可选输入作用域,指明受影响的代码区域(如 auth、api、ui)。
  3. 用祈使语气撰写简洁的变更描述。
  4. 可选添加更长的正文,提供关于变更的额外上下文信息。
  5. 如果提交引入了破坏性 API 变更,请开启“破坏性变更”并描述具体影响。
  6. 可选添加页脚引用,如 'Closes #123' 或 'Refs #456'。
  7. 开启“包含表情前缀”为提交类型添加可视化 emoji。
  8. 使用复制按钮复制生成的提交信息。

使用场景

  • 语义化版本自动化 — 使用约定式提交让 semantic-release 或 standard-version 等工具根据提交类型自动确定版本号变更(主版本、次版本、补丁版本)。
  • 自动生成变更日志 — 从提交历史自动生成结构化的变更日志,将新功能、缺陷修复和破坏性变更分类整理为有序的发布说明。
  • 团队提交规范 — 在开发团队中统一提交信息格式,使代码审查和项目历史记录更易浏览和理解。
  • 开源项目贡献 — 在向要求使用约定式提交的开源项目贡献代码时,遵循广泛采用的提交约定以配合其 CI/CD 流水线。

FAQ

什么是约定式提交格式?
约定式提交是一种编写标准化提交信息的规范。格式为:type(scope): description,后面可选跟正文和页脚。'feat' 和 'fix' 等类型分别对应语义化版本的 MINOR 和 PATCH 升级,而 'BREAKING CHANGE' 页脚或类型后的 '!' 会触发 MAJOR 版本升级。
应该使用哪种提交类型?
'feat' 用于新功能,'fix' 用于缺陷修复,'docs' 用于文档变更,'style' 用于格式调整,'refactor' 用于代码重构,'perf' 用于性能优化,'test' 用于测试变更,'build' 用于构建系统变更,'ci' 用于 CI 配置变更,'chore' 用于维护任务,'revert' 用于回退提交。
作用域是必填的吗?
不是,作用域是可选的。它提供了关于受影响代码区域的额外上下文信息(如 'auth'、'api'、'ui')。有些团队要求填写作用域,有些则将其设为可选——请遵循您项目的约定。
冒号前的 '!' 是什么意思?
放在类型/作用域之后、冒号之前的感叹号 '!' 表示破坏性变更。例如 'feat(api)!: change auth endpoint' 表示此提交引入了破坏性 API 变更,等同于添加 'BREAKING CHANGE' 页脚。
可以在提交信息中使用表情符号吗?
可以,许多团队和开源项目使用表情符号作为提交类型的可视化前缀(如 ✨ 表示 feat,🐛 表示 fix)。虽然这不是约定式提交规范的正式组成部分,但表情符号可以提高提交日志和 GitHub 界面的可读性。在本工具中开启表情选项即可添加。