返回

我是你的Git,我来教你规范Commit规范!

见解分享

Git提交规范是什么?

Git提交规范是一个定义Git提交消息格式的约定。良好的Commit Message有利于代码审查,能更快速查找变更记录,并且可以直接生成Change log。其中head((): )是必须的,body和footer是可选的。命令提交。跳出文本编辑器进行编写。commit的简短,不超过50个字符。跟subjec…

Git提交规范的好处

  • 提高代码审查效率
  • 方便查找变更记录
  • 直接生成Change log
  • 团队协作更顺畅

Git提交规范的具体要求

  • head :必须,不能省略。由<type>(<scope>): <subject>组成。其中:

    • <type>:提交类型,如fix、feat、docs、style等。
    • <scope>:提交影响的范围,如backend、frontend、database等。
    • <subject>:提交的简短,不超过50个字符。
  • body :可选,用于提供更详细的提交说明。可以分为多行,每行不超过72个字符。

  • footer :可选,用于提供额外的信息,如修复的bug号、关闭的issue号等。

Git提交规范的示例

fix(backend): 修复了一个数据库连接错误
body:

修复了一个数据库连接错误,该错误导致应用程序在某些情况下无法连接到数据库。该修复程序添加了一个新的配置选项,允许用户指定数据库连接超时。

footer:

Closes #123

如何使用Git提交规范

  1. 在提交代码之前,打开文本编辑器,写下你的提交信息。
  2. 确保你的提交信息遵循Git提交规范。
  3. 将提交信息复制到Git命令行。
  4. 提交你的代码。

Git提交规范的工具

有许多工具可以帮助你遵循Git提交规范。其中最受欢迎的工具之一是Conventional Commits。Conventional Commits提供了一套标准化的提交类型和范围,可以帮助你轻松编写规范的提交信息。

结论

Git提交规范是一个非常有用的工具,可以帮助你提高代码审查效率、方便查找变更记录、直接生成Change log,以及让团队协作更顺畅。如果你还没有使用Git提交规范,那么我强烈建议你开始使用它。