Git提交规范介绍


我相信 Git 每个程序员都不陌生,怎么用相信不用我多描述,但相信不少人的提交备注都是随意说明,并没有一个完整的规范。

就拿我自己来说,在公司项目中的提交记录起码还能描述清本次提交的代码功能,而工作之余的个人项目提交记录则是重灾区。备注说明杂乱无章,当需要定位某次提交无异于大海捞针。

1. 提交模板

下面简单介绍一下如何使用 Git 进行规范的代码提交,提交的基本模板如下:

# 简易模板
<修改类型(影响分支)>:<内容摘要>

<详细内容说明>

其中 修改类型 包含如下几类:

类型 说明
feat 表示提交新功能。
fix 表示修复了 Bug 。
docs 表示只修改了文档。
style 表示调整代码格式,未修改代码逻辑。
refactor 表示代码重构,既没修复 Bug 也没有添加新功能。
perf 表示性能优化,提高性能的代码更改。
test 表示添加或修改代码测试。
chore 表示对构建流程或辅助工具和依赖库的更改。

举个简单例子,比如在一次提交中我新增了一个全文搜索功能,那么我的提交备注就应该为如下内容:

feat(master): 新增页面内容全文搜索

在站点首页新增文章内容关键词全文搜索功能。

从上面的例子可以看出相较于以往的提交格式也就是添加一个变更类型前缀,但带来的便利却不是一点点。

如果每次提交都按模板规范提交,当别人或者你自己需要查找提交记录时根据前缀进行初步的筛选,能很清楚的知道每次提交修改的大概内容。

假如我需要查看某个功能模块的重构代码提交记录,那么我只需关注提交备注前缀为 refactor 的即可,大大提高工作效率。虽然这并不是一种强制规范,但它却能大大提高自身与他人工作效率,且操作并不繁杂,何乐而不为呢?


文章作者: 烽火戏诸诸诸侯
版权声明: 本博客所有文章除特別声明外,均采用 CC BY 4.0 许可协议。转载请注明来源 烽火戏诸诸诸侯 !
  目录