Git Commit Message规范指南

云端同学
526 阅读3分钟

Git Commit Message规范指南

一、安装插件

在开发工具idea中安装Git Commit Message Plugins插件

二、插件使用

在Commit代码处，选择使用Git Commit Message Plugins插件

三、插件讲解

主要分为下面三个部分： Header， Body，Footer。

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

下面详细解释下个个部分的含义。

Header

Header的部分只有一行,包括三个字段: type(必需), scope(可选), subject(必需)

对应到idea插件上图的配置分别为 Header部分的:

标题英文解释中文解释
type(必需)Type of changecommit类别
scope(可选)Scope of this changecommint影响的范围
subject(必需)Short description简短的描述

type

type用于说明 commit 的类别，只允许使用下面标识

  • feat：新功能（feature）
  • fix：修补bug
  • docs：文档（documentation）
  • style： 格式（不影响代码运行的变动,空格,格式化,等等）
  • refactor：重构（即不是新增功能，也不是修改bug的代码变动）
  • perf: 性能 (提高代码性能的改变)
  • test：增加测试或者修改测试
  • build: 影响构建系统或外部依赖项的更改(maven,gradle,npm 等等)
  • ci: 对CI配置文件和脚本的更改
  • chore：对非 src 和 test 目录的修改
  • revert: Revert a commit

scope

scope用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。

subject

subject是 commit 目的的简短描述，不超过50个字符。

以动词开头，使用第一人称现在时，比如change，而不是changed或changes
第一个字母小写
结尾不加句号（.）

Body

Body 部分是对本次 commit 的详细描述，可以分成多行。下面是一个范例。

如有必要，更详细的说明文本。包装它
大概72个字左右。

后面的段落在空行之后。

-要点也可以
-使用悬挂缩进

有一个注意点。

（1）应该说明代码变动的动机，以及与以前行为的对比。

3、Footer

Footer 部分只用于两种情况。

（1）不兼容变动

如果当前代码与上一个版本不兼容，则 Footer 部分以BREAKING CHANGE开头，后面是对变动的描述、以及变动理由和迁移方法。

（2）关闭 Issue

如果当前 commit 针对某个issue，那么可以在 Footer 部分关闭这个 issue 。

Closes #123

也可以一次关闭多个 issue 。

Closes #123, #234, #345

最后, 一个完整的commit message示例可能如下:

四、git hooks校验

由于使用idea插件只防君子，不防小人。Git Commit Message Plugins只能起到模板的作用，开发人员如果误操作或者忘记使用任提交不规范的Commit Message。因此使用git hooks强制开发人员使用以上格式提交。具体操作如下：

在项目目录.git/hooks目录下有很多钩子，我们可以根据需要自定义不同的内容，这里我们只需要修改commit-msg即可。

首先将commit-msg.sample 改为 commit-msg，也就是去掉后缀。将里面的内容修改为下面内容。

#!/bin/sh

MSG=`awk '{printf("%s",$0)}' $1`
if [[ $MSG =~ ^(feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)\(.*\):.*$ ]]
then
	echo -e "\033[32m commit success! \033[0m"
else
    echo -e "\033[31m Error: the commit message is irregular \033[m"
	echo -e "\033[31m Error: type must be one of [feat,fix,docs,style,refactor,perf,test,build,ci,chore,revert] \033[m"
    echo -e "\033[31m eg: feat(user): add the user login \033[m"
	exit 1
fi
avatar
文章
阅读
粉丝