Git每次提交代码时,都要写Commit Message(提交说明),通常情况下,Commit Message应该清晰明了,说明本次提交的目的和具体操作等。然而笔者工作多年来发现,有些公司对Commit Message没有明确的要求,这导致每个人都按自己熟悉的方式提交代码。例如,有些人会写此次代码的修改是基于哪个模块,有些人会写解决了哪些Bug,有些则只写修改了哪个文件,中英文混用等等五花八门的Commit格式,这导致后续的代码维护成本很高,有时候提交人看Commit Message都不知道自己改了什么。
没有统一的提交格式要求,对于代码提交管理,追溯,查阅等都造成了很多麻烦。比如查阅某个业务的修改历史,查阅某个时间段修复了哪些Bug,因为Commit没有统一的格式,就比较难快速获取这些信息。如果在团队中大家遵守一种统一的提交规范提交代码,使用Git命令就可以非常方便地获取提交信息。我们希望通过一种约定式的Commit Message,以提高代码提交规范,提高开发效率。
如果您所在的团队没有规范提交,建议您推动这项改善,这将极大的改善团队的开发协同效率。您是否在查阅别人代码时,经常在Commit Message中发现如下关键字,这正是一种规范提交的措施。
feat - 新功能 feature
fix - 修复 bug
docs - 文档注释
style - 代码格式(不影响代码运行的变动)
refactor - 重构、优化(既不增加新功能,也不是修复bug)
perf - 性能优化
test - 增加测试
chore - 构建过程或辅助工具的变动
revert - 回退
build - 打包
在此,笔者为大家推荐一个规范Git提交的参考项目:
约定式提交 (conventionalcommits.org). https://www.conventionalcommits.org/zh-hans/v1.0.0/
每个公司都可以根据自己的实际情况约定一些提交规范。尤其是在一些大型项目中,约定Commit Message 是非常重要的,这将极大地改善团队协作的效率,减少一些不必要的沟通。
看似微不足道的改善,隐含着巨大的效益~