git commit message

https://www.cnblogs.com/deng-cc/p/6322122.html


1、触发事件

我有这样一个版本库,里面包含两个学习用的练习项目:BookStore(以下简称BS)和PictureFriend(以下简称PF)

我在更改PF以后,未进行提交,同时又到BS中优化了一下文件夹结构,然后此时我commit,提交备注信息为“添加图友网项目,更改为Maven形式,报错找不到spring监听器,待解决”,提交成功,似乎没什么问题。

但是当我在github上看到的情况如下,我知道我没有处理好:
 
BookStore项目实际上跟这个备注并没有关系,而是PictureFriend才主要是这次commit的内容,只是因为我将两个项目的操作在同一次commit中进行提交,造成了这样的情况。可见如果是正式的项目,如此的提交是多么混乱,他人将难以维护和修改。

究其原因,主要还是在正确的git提交姿势上知之甚少:
1、不同的要分别分次提交,(这里不同指 如:不同的修改类型//优化还是新增etc.//,不同的模块,不同的功能等);
2、提交的信息要进行一定程度的格式化。



2、知之为知之

commit的写法规范有很多,以下参考网络相关文章,并进行简化以定义个人风格。
参考链接:

2.1 Commit message的格式化

每次提交,Commit message 都包括两个核心部分:标题 和 内容
  1. <类型>(可选): <主题>
  2. // 空一行
  3. <内容>
其中,标题 是必需的,内容无需过多描述的话,正文内容部分可以省略。

不管是哪一个部分,任何一行都不得超过72个字符(或100个字符)。这是为了避免自动换行影响美观。

2.1.1 标题

标题部分只有一行,包括字段:类型 和 主题

标题限制总字数在50个字符以内,以保证容易阅读。

e.g.
  1. feat: init LearnGit.git
  2. I got a wrong-style git commit, so I init a .git for learning
  3. how to write a git commit message in right way.
  4. And the last line just write here for a simple test,
  5. it's useless acturally.

2.1.1.1 类型

类型 用于说明 commit 的类别,只允许使用下面7个标识。
  • init:项目初始化(用于项目初始化或其他某种行为的开始描述,不影响代码
  • feat:新功能(feature)
  • fix:修补bug
  • docs:文档(documentation)
  • opt:优化和改善,比如弹窗进行确认提示等相关的,不会改动逻辑和具体功能等
  • style: 格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • test:增加测试
  • other:用于难以分类的类别(不建议使用,但一些如删除不必要的文件,更新.ignore之类的可以使用)

(可选)类型后面可以加上括号,括号内填写主要变动的范围,比如按功能模块分,某模块;或按项目三层架构模式分,分数据层、控制层之类的。
  • #:表示模块
    • #student --> 表示 学生模块 (具体的模块开头字母小写,驼峰命名)
    • #ALL --> 表示 所有模块 (特殊含义如ALL表所有,MOST表大部分,用大写字母表示)
    • #MOST --> 表示 大部分模块

e.g. feat(#student): 新增添加学生的功能 —— 表示student模块新增功能,功能是添加学生

2.1.1.2 主题

主题 是 commit 目的的简短描述,不超过50个字符。
  • 以动词开头,使用第一人称现在时,比如change,而不是changed或changes
  • 第一个字母小写
  • 结尾不加句号(.)

2.1.2 内容

内容部分是对本次 commit 的详细描述,可以分成多行,正文在 72 个字符处换行。

使用正文解释是什么(what)和为什么(why),而不是如何做,以及与以前行为的对比。

于是可以这样写:
balabala : balabala

what:
balabala

why:
balabala




2.2 格式化后Commit message的好处

2.2.1 提供更多的历史信息,方便快速浏览

直接使用git log你得到的是:
 
比如,下面的命令显示上次发布后的变动,每个commit占据一行。你只看行首,就知道某次 commit 的目的。
  1. $ git log <last tag> HEAD --pretty=format:%s
关于更多git log的输出格式,参考以下:

2.2.2 可以过滤某些commit(比如文档改动),便于快速查找信息

比如,下面的命令仅仅显示feat类型的commit。
  1. $ git log <last release> HEAD --grep feat
 
当然,你还可以这样:

关于更多过滤规则,参考以下:
e.g.
 

阅读更多
个人分类: git
上一篇手把手教你jmeter压测
下一篇Commit message 和 Change log 编写指南
想对作者说点什么? 我来说一句

没有更多推荐了,返回首页

关闭
关闭