Git提交消息生成器
免费在线 Git 提交消息生成器,免安装。生成符合常规提交规范的提交消息
什么是约定式提交?
约定式提交(Conventional Commits)是一种编写提交消息的规范,为自动化工具提供一致的格式,并更易于理解变更。每条提交消息遵循以下结构:type(scope): description。常见类型包括 feat(新功能)、fix(修复bug)、docs(文档)、style(格式化)、refactor(代码重构)、perf(性能优化)、test(测试)、chore(维护)、build(构建系统)、ci(CI配置)和 revert(回滚提交)。
如何使用 Git 提交生成器
从可用选项中选择提交类型(feat、fix、docs 等)。可选择添加作用域(scope)来指示代码库的哪一部分受到影响(例如:auth、components、api)。用祈使语气编写清晰的主题行,描述提交做了什么以及为什么。可选择添加详细的正文来更全面地解释变更。对于破坏性变更,勾选「破坏性变更」复选框。点击「生成」创建提交消息,然后复制到您的 Git 工作流中使用。
提交消息最佳实践
使用祈使语气(「添加功能」而不是「添加了」或「添加」)。主题行保持在72个字符以内。解释做了什么和为什么,而不是如何做。在页脚中引用相关问题(例如:Closes #123)。对于破坏性变更,在正文或页脚开头添加「BREAKING CHANGE: 」。在整个项目中保持一致。
▶为什么要使用约定式提交?
约定式提交支持自动化工具,如变更日志生成器、语义化版本控制和提交检查。它们使 git 历史记录更具可读性,并通过标准化提交消息格式帮助团队更有效地协作。
▶提交消息中的作用域(scope)是什么?
作用域是一个可选的括号部分,指示代码库的哪一部分受提交影响。常见的作用域包括组件名称、模块或区域,如 auth、api、ui、database 等。作用域有助于在浏览 git 历史记录时对变更进行分类。
▶什么时候应该将提交标记为破坏性变更?
当提交引入不兼容的 API 变更、删除功能或进行需要用户更新代码的更改时,应将其标记为破坏性变更。这向消费者发出信号,告知他们在升级时需要采取行动。
▶我可以自定义提交类型吗?
此工具提供标准的约定式提交类型。如果您的项目使用自定义类型,您可以生成消息,然后在提交前进行编辑。该工具为任何提交消息提供了坚实的起点。
如果这个工具帮到了你,可以请作者喝杯咖啡。
请我喝杯咖啡