大家有没有遇到过,git log 查看代码提交记录的时候每个人都有自己的风格,有的详细,有的简单到让你摸不着头脑。

那么如何让大家书写规范的提交记录?当然靠宣贯和自觉肯定是不行的,过了一段时间又恢复原样了。

这里分享一个最佳实践,强制大家提交代码时按照规范的模板来写。这就要用到.git-commit-template了,我是这么做的:

xxx@CNFFSAPP0108:~$ cat .git-commit-template
问题来源及描述:
所属模块:
问题原因:
解决方法:
项目平台:T7/C490
问题单号:000
修改类型:修改问题/新功能开发
 

然后配置.gitconfig ,如下:

xxx@CNFFSAPP0108:~$ cat .gitconfig
[alias]
        st = status
        co = checkout
        ci = commit
        br = branch
        lg = log --color --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit
        last = log -1
[user]
        name = alex.liu
        email = alex.liu@.com
[core]
        whitespace = cr-at-eol
[gitreview]
        username = alex.liu
[commit]
        template = /home/liuyf/.git-commit-template
 

这样配置以后,每次git commit会自动弹出上面的模板,大家按照规范填写即可。如果不按照规范填写的可以定期抽查,非常方便。从此团队向正规军又靠近了一步。

Logo

瓜分20万奖金 获得内推名额 丰厚实物奖励 易参与易上手

更多推荐