简介:commit message应该如何写才更清晰明了?团队开发中有没有遇到过让人头疼的git commit?本文分享在git commit规范建设上的实践,规定了commit message的格式,并通过webhook在提交时进行监控,避免不规范的代码提交。
背景
因为某盘的限速功能真的是让我一个脑袋两个大,实在没办法了,就把一些资料上传到了我的git上,今天从git上扒东西的时候,家里的小朋友跟我说,你这好像一个大的网盘呀,我突然灵机一动,对啊,git用明白了真的是很厉害呀,但是git的提交也是很让人头疼的,像我个人工作还好,但是一个项目的开发,肯定需要很多人,每个人都会向上提交,而Git每次提交代码都需要写commit message,否则就不允许提交。一般来说,commit message应该清晰明了,说明本次提交的目的,具体做了什么操作……但是在日常开发中,大家的commit message千奇百怪,中英文混合使用、fix bug等各种笼统的message司空见怪,这就导致后续代码维护成本特别大,有时自己都不知道自己的fix bug修改的是什么问题。基于以上这些问题,我们希望通过某种方式来监控用户的git commit message,让规范更好的服务于质量,提高大家的研发效率。
规范建设
规范梳理
初期我们在互联网上搜索了大量有关git commit规范的资料,但只有Angular规范是目前使用最广的写法,比较合理和系统化,并且有配套的工具(IDEA就有插件支持这种写法)。最后综合阿里巴巴高德地图相关部门已有的规范总结出了一套git commit规范。
commit message格式
<type>(<scope>): <subject>
type(必须)
用于说明git co