如何写好 Git commit messages

最新推荐文章于 2023-12-26 14:41:39 发布
最新推荐文章于 2023-12-26 14:41:39 发布
阅读量249 收藏
点赞数

导语：任何软件项目都是一个协作项目，它至少需要2个开发人员参与，当原始的开发人员将项目开发几个星期或者几个月之后，项目步入正规。不过他们或者后续的开发人员仍然需要经常提交一些代码去修复bug或者实现新的feature。我们经常有这种感受：当一个项目时间过了很久之后，我们对于项目里面的文件和函数功能渐渐淡忘，重新去阅读熟悉这部分代码是很浪费时间并且恼人的一件事。但是这也没法完全避免，我们可以使用一些技巧尽可能减少重新熟悉代码的时间。commit messages可以满足需要，它也反映了一个开发人员是否是良好的协作者。

编写良好的Commit messages可以达到3个重要的目的：

  • 加快review的流程
  • 帮助我们编写良好的版本发布日志
  • 让之后的维护者了解代码里出现特定变化和feature被添加的原因

先来看看一个比较好的例子，感受一下：

下面谈谈，如何让项目里面的Commit messages步入规范化，流程化。

Commit messages的基本语法

<type>: <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Type表示提交类别，Subject表示标题行， Body表示主体描述内容。

Type的类别说明：

  • feat: 添加新特性
  • fix: 修复bug
  • docs: 仅仅修改了文档
  • style: 仅仅修改了空格、格式缩进、都好等等，不改变代码逻辑
  • refactor: 代码重构，没有加新功能或者修复bug
  • perf: 增加代码进行性能测试
  • test: 增加测试用例
  • chore: 改变构建流程、或者增加依赖库、工具等

Commit messages格式要求

# 标题行：50个字符以内，描述主要变更内容
#
# 主体内容：更详细的说明文本，建议72个字符以内。 需要描述的信息包括:
#
# * 为什么这个变更是必须的? 它可能是用来修复一个bug，增加一个feature，提升性能、可靠性、稳定性等等
# * 他如何解决这个问题? 具体描述解决问题的步骤
# * 是否存在副作用、风险? 
#
# 如果需要的化可以添加一个链接到issue地址或者其它文档

这3个问题给代码的变更建立了良好的上下文，可以让其他的代码review人员或者项目成员直观的判断修改点是否正确。一条良好的commit message也可以让维护者知道这个patch是否适合发布到稳定的版本中去。

如果一个patch没有回答上面的这几个问题，那么它是无意义的。它会给review的人员造成负担，让他们花费大量时间去评审讨论这个patch的作用和意义。更糟糕的是，如果一个项目实施SCM纪律，则这个patch会被拒绝掉，然后开发人员需要花费时间重新编写一个新的patch。重新编写一个复杂的patch代价是巨大的，而把commit message写好只会花费几分钟。

Commit messages书写建议

  • 尽可能多的提交，单个Commit messages包含的内容不要过多
  • 标题行以Fix, Add, Change, Delete开始，采用命令式的模式。不要使用Fixed, Added, Changed等等
  • 始终让第二行是空白，不写任何内容
  • 主体内容注意换行，避免在gitk里面滚动条水平滑动
  • 永远不在 git commit 上增加 -m 或 --message= 参数，提交的时候git commit即可。
  • 如果你是vim用户，将下面这行代码加入到~/.vimrc。这会帮助你检查拼写和自动换行
    sh autocmd Filetype gitcommit setlocal spell textwidth=72

使用Commitizen工具

Commitizen可以让你的commit message更加规范统一，适合项目团队使用，使用也很简单，使用npm安装后，提交代码的时候使用git cz去替代以前的git commit命令即可。

安装commitizen：

$ npm install -g commitizen

使用截图：

自动生成Change log

conventional-changelog是用来从git的元数据中生成 Change log文档的工具，只要你提交的格式满足它定义的标准，此处以angular标准为例子。使用它生成的Change log包含以下三个部分：

Bug Fixes Bug修复的信息
Features 增加的特性
BREAKING CHANGES 重大变更

可以参考它生成的文档CHANGELOG.md，使用如下：

$ npm install -g conventional-changelog-cli
$ cd my-project
$ conventional-changelog -p angular -i CHANGELOG.md -s

这不会覆盖你之前的CHANGE.md文档内容，会在这个文件的最上面插入新生成的日志信息。

参考链接

  • Git Commit Messages : 50/72 Formatting
  • Distributed Git - Contributing to a Project
  • thoughtbot
  • Erlang otp
  • Commit messages standard
  • conventional-changelog-cli
ftxv95x5
关注
[程序员最佳实践学习] git commit 如何写 ? git 分支如何使用? bean copy 最佳实践?
AI天才研究院
04-28 8670
git commit 如何写 ? changelog规约: https://github.com/conventional-changelog/ commit代码检查: https://commitlint.js.org/#/concepts-shareable-config 要精心构思,不可随意为之. 一个提交信息可以表明一个开发者是不是一个好的合作...
git commit规范与配置
weixin_54882114的博客
03-12 3745
一、需求场景 在一个开发团队中，前端开发的代码管理越来越规范化、工程化，而代码commit更是需要一个统一的规范去约束，保证代码commit时的规范性。尤其多人参与一个项目开发时，大家的代码commit风格不相同，不便于后续的代码统一管理和可读性；所以良好的git commit风格是很重要的。 二、使用工具 1、commitlint 很多时候我们提交代码时，运行git commmit -m 'xxx'即可，而commitlint可以对message进行约束，是判...
如何写好 Git Commit 信息
qianggezhishen的专栏
12-01 797
英文： http://chris.beams.io/posts/git-commit/中文： http://blog.jobbole.com/92713/
git-commit Angular规范
12-18 461
commit message的格式 每次提交，Commit message 都包括三个部分：Header，Body 和 Footer。 <type>(<scope>): <subject> // 空一行 <body> // 空一行 <footer> 其中，Header 是必需的，Body 和 Footer ...
Git Commit Message 应该怎么写？
2201_75761617的博客
07-24 100
最近被同事吐槽了，说我代码提交说明写的太差。其实都不用他吐槽，我自己心里也非常清楚。毕竟很多时候犯懒，都是直接一个-m "fix"就提交上去了。这样做是非常不好的，我也是自食恶果，深受其害。特别是查看历史提交记录时，想通过提交说明来了解当时的功能变更，基本不可能，都得点进去看代码才行。所以这两天看了一些的资料，系统地学习了一下。虽然团队没有这方面的要求，但是想要进步，得对自己提更高的要求才行。一般使用 git 提交代码的话，可以使用-m如果一行不够，可以只执行git commit。
cmt：基于自定义模板编写一致的git commit消息
02-03
而`git-commit-messages`则强调了`cmt`的核心功能，即改善和标准化git commit消息的编写。 在`cmt-master`这个压缩包中，可能包含了`cmt`工具的源码、编译后的二进制文件、使用文档和示例模板。如果你打算在项目中...
一文搞定规范化Git Commit
mashibing_web的博客
09-28 747
前言 规范化 git commit 对于提高 git log 可读性、可控的版本控制和 changelog 生成都有着重要的作用。然而阻碍我们脚步的不只是团队的推广，单单对于一系列工具的配置都让人头大。这其中主要就是 commitlint 和 commitizen 的配合使用以及自定义提交规范。本文总结了目前的最佳实践给大家，如果有帮助，赏个star足矣。 Conventional Commits 约定式提交规范 Conventional Commits 是一种用于给提交信息增加人机可读含义的规范。约定式提
怎么写一个好的 Git commit message
Liu-Cheng Xu
10-10 5862
网络上很多关于 commit message 的想法都来源于 tpope，在他看来，一个好的 Git commit messge 应该是这样的： Capitalized, short (50 chars or less) summary More detailed explanatory text, if necessary. Wrap it to about 72 chara
git commit 代码提交规范
小妖666个人笔记
12-08 2217
我们在代码提交时 git 的 commit 信息是很重要的，但是每次写的时候总想偷懒怎么办，咱们可以制定个规范必须按照某种格式提交注释。 法一：设置 git commit 模板 在项目中建立 .git_template 文件，内容可以自定义： .git_template type: description: 运行如下命令： git config commit.template .git_template git commit 时会出现上面的模板 这种方法只是规范了一些，但是没有校验方式
标准的git commit写法
youshuang1207的博客
04-06 236
git commit -m 'feat: xxx功能开发' git commit -m 'fix(account): 修复xxx的bug'
Git —— Commit Message 规范介绍
最新发布
Ccccxc的博客
12-26 2839
日常开发中，我们经常会使用到 Git 进行代码管理，而 Git 中最常用的命令就是git commit，我们通过 commit 命令将修改后的代码提交到本地仓库，然后再通过git push命令将本地仓库的代码推送到远程仓库。git 规定提交时必须要写提交信息，作为改动说明，保存在 commit 历史中，方便回溯。规范的 log 不仅有助于他人 review, 还可以有效的输出 CHANGELOG，甚至对于项目的研发质量都有很大的提升，尤其是一些长期持续迭代维护，且多版本长期并存的项目。
Git Commit Message 规范
Dablelv 的博客专栏。
05-11 1491
大咖好呀，我是恋喵大鲤鱼。Git 是一个免费开源的分布式版本控制系统，由 Linux 之父 Linus Torvalds 于 2005 年开发，最初的目的用于管理 Linux 内核的开发。因其高效的性能、便捷的分支管理、免费开源等优秀特性，一经推出，很快在全球范围内得到广泛使用，成为最流行的版本控制系统，没有之一。当我们使用 Git 对代码进行版本管理时，经常需要将变更推送至远端。每次提交变更时，我们需要书写 Commit Message 描述此次变更的内容。
git的commit的注释前缀
weixin_38622325的博客
12-27 1875
git的commit的注释前缀 feat：新功能（feature） fix：修补bug docs：文档（documentation） style： 格式（不影响代码运行的变动） refactor：重构（即不是新增功能，也不是修改bug的代码变动） test：增加测试 chore：构建过程或辅助工具的变动 ...
Commit Message 规范
weixin_34150830的博客
11-03 210
统一团队 Git commit 日志标准，便于后续代码 review ，版本发布以及日志自动化生成等等。统一团队的Git工作流，包括分支使用、tag 规范、issue 等。 Git commit日志基本规范 <type>(<scope>): <subject> <BLANK LINE> ...
Commit message 的格式说明
禅思院
03-13 6516
每次提交，Commit message 都包括三个部分：Header，Body 和 Footer。其中，Header 是必需的，Body 和 Footer 可以省略,不管是哪一个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免自动换行影响美观。 &lt;type&gt;(&lt;scope&gt;): &lt;subject&gt; // 空一行 &lt;body&g...
提交信息规范
weixin_33751566的博客
12-17 397
commit message格式说明commit message一般包括三部分：Header、Body和Footer。 Headertype(scope):subject type：用于说明commit的类别，规定为如下几种 feat：新增功能；fix：修复bug；docs：修改文档；refactor：代码重构，未新增任何功能和修复任何bug；build：改变构建流程，新增依赖库、工具等（例如...
修改 commit message
Metaphors' Blog
01-20 1654
本文为原创文章，转载请标明出处 目录 修改上一条提交的 commit message 修改之前提交的 commit message 1. 修改上一条提交的 commit message git commit --amend 2. 修改之前提交的 commit message 比如说，我想修改距此版本之前的第3条 commit message，运行 git re
修改commit的message
无聊达的博客
08-10 6823
对最近commit的message进行修改： git commit --amend 会弹出一个文本让你修改，第一行就是描述用的message 对以前提交的commit的message进行修改（较难） 如果我们要修改“子”这条commit的message，我们要使用“父”这个commit的id， git rebase -i id 我们把第一行的pick改成r（文本编辑器的...
一键安装Git Commit规范校验与模板工具
.gitcommit文件可以是提交模板文件，而.commit-msg文件则是校验脚本文件，用于在提交时校验提交信息。 8. 一键安装的意义： 一键安装指的是通过简单的一个或几个步骤就可以完成软件或工具的安装过程。本资源提供了...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值