如何设置Git提交注释模板

如何设置Git提交注释模板

  在使用Git做版本控制工具的团队协作开发中，为了保证团队成员在提交代码时注释的规范性，我们通常都希望制定这样一种规范来约束他们，下面我将介绍如何在Git命令行下和TortoiseGit可视化界面下设置提交注释模板。

---

Git命令行下设置提交注释模板

• 创建xxx_template文件，其内容为团队制定的Git提交注释规范，如：

Desgraption:
Date:
Author:

• 通过git config命令配置commit_template，如：

git config –global commit.template /d/develop/Git/Git_Home/commit_template

• 设置git commit时填写注释所用的编辑器，如：

git config –global core.editor vi

• OK，设置完成，提交使用git commit会出现与下图相似的界面填写好注释才能提交成功:

PS：与团队成员约定做git提交时使用git commit，不能直接用git commit -m跳过规范。

---

TortoiseGit可视化界面设置提交注释模板

• 首先打开TortoiseGit的设置界面，如下：

• 然后编辑上图中所示的全局.gitconfig文件，不在本地.gitconfig中编辑是因为本地.gitconfig文件中的配置只在当前分支中生效，而只有在全局.gitconfig中的配置才能在整个当前项目中生效。在文件中配置commit的template属性为你已经事先准备好的xxx_template文件，如：

• 最后编辑好全局.gitconfig文件后保存并关闭，之后在做提交时注释处会出现我们预先配置好的注释规范，按规范填写好注释后即可提交：

---

待续

  上述设置只能给团队成员一个注释模板，但是我们并能未在其提交时对其所填写的注释进行检查是否符合规范，后面待研究好commit_msg钩子后再来更新如何在提交时检查注释是否真的按规范填写。