一文教你如何设置git commit模板规范

一、git log之痛

今天看公司代码的提交历史，发现信息量过少，甚至是误导的commit message非常常见，并且无法定位到禅道的相关任务（有的公司用的是jira），对新人来说，查找以往的提交记录很不友好。
为方便新人更快更准确的理解工程师所提交的需求或缺陷，git在提交时需要指定格式提交，下面给git配置一个提交模板，配置好后，每次gitcommit时都会将模板中的信息作为初始化信息自动填充到编辑器的提交信息中。

二、步骤

1、以命令的方式配置，在git中输入以下命令

 git config --global commit.template ~/.git-commit-template

2、打开.gitconfig文件，发现以命令的方式执行后，它会自动在.gitconfig配置文件中生成这一项，git commit的时候就会去配置文件中读取这一项指定的文件中的内容作为初始化信息填写到提交信息中。


3、在.gitconfig文件的同级目录下新建以.git-commit-template命名的文本文件，并把下面的模板拷贝到该文件中保存即可。

[修改类型][原因分析][影响范围][Task_id]

#[修改类型] 修改内容
#
#[原因分析]
#[影响范围] 填写模块名称
#[Task_id] 禅道任务ID

#修改类型 :
#1.config :简单配置需求
#2.bugfix :由缺陷主导的代码修改
#3.feature :功能模块的添加，与bugfix独立

#修改内容：
#此次修改的简要标题，标题简要的描述修改的主要目的（不超过20个汉字，80个字符）

#原因分析：
#针对提交进行的原因描述

#影响范围：
#填写模块名称

#[Task_id] 添加关联的禅道任务ID，没有则需要确认是否需要新建任务

修改类型根据需求修改为对应的config/feature/bugfix。git log显示内容与提交模板一致。