【规范】看看人家Git提交描述，那叫一个规矩

迈不过友情╰ 2024-05-11 09:08 78阅读 0赞

### 前言 ###

#### ?缘由 ####

##### 没想到玩了多年git，竟然还有提交描述规范 #####

![在这里插入图片描述][592a05d8bea5427c8c7284a0d423de19.png]

?事情起因：  
在工作迭代过程中，偶然发现同组小帅哥**Git提交描述**总是和自己的不大一样，秉承好奇至上的我特意去研究了下。竟然发现提交了这么多年的Git描述竟然不符合规范，遂总结一下**大厂**和一些**开源项目**的的**Git提交规范**，跟大家分享一下。

--------------------

#### ?实例展示 ####

##### 规范Git提交记录 #####

![在这里插入图片描述][51de6888405d483e87b42bb7aa9feb21.png]  
![在这里插入图片描述][42568a44bb1144e4bcacc63becdf6732.png]

##### 本狗不规范Git提交记录 #####

![在这里插入图片描述][a87cc634139044c0bb31aa2bb50fcb24.png]  
![在这里插入图片描述][492d0e44d9b648618cedceb0f4988d16.png]

? 分析  
在**团队开发**中，一般都会使用**Git 版本控制工具来管理代码**，每个组员提交代码时都会写 **commit message**。如果**没有一个统一标准规范**，每个人都有自己的风格，项目小成员少还好，如果团队成员多，项目复杂，十分**不利于阅读管理和维护**。

通过上方图中提交记录对比，明显感觉**上方Git提交记录较为规范美观**。虽然本狗写的提交记录也比较清晰，但是随着项目推进及人员的混杂，规范标准必须执行！

因此为了后期一劳永逸，需要制定统一标准，提交记录清晰明了，让团队一看就能知道此次提交的目的，减少管理时间成本。

--------------------

#### ?主要目标 ####

##### 实现3大重点 #####

###### 1. IDEA Git描述规范插件 ######

###### 2. Git提交描述格式规范 ######

###### 3. 实例Git提交描述解析 ######

### 正文 ###

#### ?目标分析 ####

##### 1.IDEA Git描述规范插件？ #####

###### 【git commit message helper】介绍 ######

> 一个可帮助您标准化提交内容的插件

![在这里插入图片描述][020e25160bfd4ad2b699b035d174a040.png]

###### 【git commit message helper】 插件安装步骤 ######

*  点击【File】=>【Settings】  
    ![在这里插入图片描述][73d6fc9f8a5a4a16b1a79e91e89edbca.png]
 *  【Plugins】=>【Marketplace】搜索 git commit message helper，点击【Install】  
    ![在这里插入图片描述][0e6c7a6b2d324f6a940b13e08e981660.png]
 *  安装后点击【Installed】查看是否成功  
    ![在这里插入图片描述][2a52d87a91b44c4da90d0f3361a73dc3.png]

###### 【git commit message helper】 使用 ######

*  代码提交时，点击如下图标

![在这里插入图片描述][a1e9fd3d334241f0af8034fa864fcb66.png]

*  补充提交记录  
    ![在这里插入图片描述][62c2bf662de44fde9bbfcacb7492ce12.png]  
    有问题先别着急，耐心往下看，慢慢分析每个属性！！！

--------------------

##### 2. Git提交描述格式规范解析 #####

Git提交描述规则可以映射到插件下图部分，Header， Body，Footer  
![在这里插入图片描述][870ee3d7e4564506bedfd57d1d45b3cc.png]  
一个规范的Git提交描述格式如下

# Header头
    <type>(<scope>): <subject>
    
    # Body体
    <body>
    
    # Footer体
    <footer>

###### 1.Header头 ######

Header头只有一行,包括3个字段: type(必需), scope(可选), subject(必需)

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>type(必填)</td> 
   <td>commit提交类型</td> 
  </tr> 
  <tr> 
   <td>scope(选填)</td> 
   <td>commint提交影响范围</td> 
  </tr> 
  <tr> 
   <td>subject(必填)</td> 
   <td>commint提交简短描述</td> 
  </tr> 
 </tbody> 
</table>

*  type 提交类型

**type说明提交类型**：只允许使用下面属性

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>feat</td> 
   <td>新功能</td> 
  </tr> 
  <tr> 
   <td>fix</td> 
   <td>修改bug</td> 
  </tr> 
  <tr> 
   <td>docs</td> 
   <td>文档修改</td> 
  </tr> 
  <tr> 
   <td>style</td> 
   <td>格式修改</td> 
  </tr> 
  <tr> 
   <td>refactor</td> 
   <td>重构</td> 
  </tr> 
  <tr> 
   <td>perf</td> 
   <td>性能提升</td> 
  </tr> 
  <tr> 
   <td>test</td> 
   <td>测试</td> 
  </tr> 
  <tr> 
   <td>build</td> 
   <td>构建系统</td> 
  </tr> 
  <tr> 
   <td>ci</td> 
   <td>对CI配置文件修改</td> 
  </tr> 
  <tr> 
   <td>chore</td> 
   <td>修改构建流程、或者增加依赖库、工具</td> 
  </tr> 
  <tr> 
   <td>revert</td> 
   <td>回滚版本</td> 
  </tr> 
 </tbody> 
</table>

*  scope 作用范围

**scope说明提交影响范围**：一般是修改的什么模块或者是什么功能，如【xx模块】/【xx功能】

*  subject 提交主题

**subject 说明提交简短描述**：一般是5-10各自简单描述做的任务，如【xx模块加入消息队列】

###### 2.Body体 ######

**body说明提交详细描述**：对于功能详细的描述，解释为什么加入这段代码，为什么调整优化等，如因分布式锁问题，导致死锁问题，优化调整xxxx

###### 3.Footer脚 ######

.Footer脚包括2个字段: Breaking Changes、Closed Issues

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Breaking Changes</td> 
   <td>中断性不兼容变动(不常用)</td> 
  </tr> 
  <tr> 
   <td>Closed Issues</td> 
   <td>关闭Issues问题</td> 
  </tr> 
 </tbody> 
</table>

*  Breaking Changes

**当前版本与之前版本不兼容**，如迭代升级对之前版本不能做到兼容，就需要在**Breaking Changes**后面描述变动理由和迁移方法之类，此属性不常用

*  Closed Issues  
    当前 commit提交针对某个issue问题或者是禅道bug编号等，如Closes \# 234

###### 4.完成填充示例 ######

![在这里插入图片描述][5a2c98d18afe4b10ac1e9ca1f068baea.png]

##### 3. 实例Git提交解析 #####

举几个常用git提交描述案例

###### 短信模块新功能提交 ######

![在这里插入图片描述][17f66d3c699e430999655b2ad28da7b6.png]  
![在这里插入图片描述][a441d9d3df3240eea602617d96fe38c5.png]

###### 用户模块禅道bug1026修复提交 ######

![在这里插入图片描述][43a8cd2684664505abf8f6c5edd370b9.png]  
![在这里插入图片描述][a5913cb4ecbb473986b64b374a9be2f6.png]

###### 迭代SQL脚本提交 ######

![在这里插入图片描述][709f921615514f7a8a27e1e4b17b108e.png]  
![在这里插入图片描述][d0f4f669cb5349d3ab0e19484d96375d.png]

### 总结 ###

本文通过IDEA中Git描述规范插件【git commit message helper】为契机，介绍**Git提交描述**的**规范流程步骤**，最后以实际例子作为体验对象，融汇插件及规范流程，实操Git Commit提交描述。**希望大家能体会到流程的好处，团队规范统一的益处**。

#### ?猜你想问 ####

##### 如何与狗哥联系进行探讨 #####

###### 关注公众号【JavaDog程序狗】 ######

公众号回复【入群】或者【加入】，便可成为【程序员学习交流摸鱼群】的一员，问题随便问，牛逼随便吹。  
![在这里插入图片描述][e55c65b223664e6dbed5961ecea0d270.png]

**此群优势：**

1.  技术交流随时沟通
2.  任何私活资源免费分享
3.  实时科技动态抢先知晓
4.  CSDN资源免费下载
5.  本人一切源码均群内开源，可免费使用

###### 2.踩踩狗哥博客 ######

[javadog.net][]

> 大家可以在里面留言，随意发挥，有问必答

![b98f327f0a078f13b2b80f064914d622.png][]

--------------------

#### ?猜你喜欢 ####

##### 文章推荐 #####

[【工具】用nvm管理nodejs版本切换，真香！][nvm_nodejs]

[【苹果】SpringBoot监听Iphone15邮件提醒，Selenium+Python自动化抢购脚本][SpringBoot_Iphone15_Selenium_Python]

[【项目实战】SpringBoot+uniapp+uview2打造H5+小程序+APP入门学习的聊天小项目][SpringBoot_uniapp_uview2_H5_APP]

[【项目实战】SpringBoot+uniapp+uview2打造一个企业黑红名单吐槽小程序][SpringBoot_uniapp_uview2]

[【模块分层】还不会SpringBoot项目模块分层？来这手把手教你！][SpringBoot]

[【ChatGPT】手摸手，带你玩转ChatGPT][ChatGPT_ChatGPT]

[【ChatGPT】SpringBoot+uniapp+uview2对接OpenAI，带你开发玩转ChatGPT][ChatGPT_SpringBoot_uniapp_uview2_OpenAI_ChatGPT]

--------------------

![在这里插入图片描述][e74f3636c05a430eab8819333fa004eb.jpeg]

[592a05d8bea5427c8c7284a0d423de19.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/25d6779b01c941708632c8e9c4e29e80.png
[51de6888405d483e87b42bb7aa9feb21.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/02c9e0fb484646c99531f4db3f805340.png
[42568a44bb1144e4bcacc63becdf6732.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/c50be272f9114959b95a9a6b308370e4.png
[a87cc634139044c0bb31aa2bb50fcb24.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/e265c03ae8a34addb1ebd297ecd4f9dc.png
[492d0e44d9b648618cedceb0f4988d16.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/307627a02a314730b17d78e86ccb917b.png
[020e25160bfd4ad2b699b035d174a040.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/bc8fe5938b3c4a21bb943702ae366da2.png
[73d6fc9f8a5a4a16b1a79e91e89edbca.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/24f1bd83d4644795863fb692af53e20b.png
[0e6c7a6b2d324f6a940b13e08e981660.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/6729c72ab373420f87a987f552216f31.png
[2a52d87a91b44c4da90d0f3361a73dc3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/eb0ea57d67d74d778aed5bf37f180e9f.png
[a1e9fd3d334241f0af8034fa864fcb66.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/3345e20c50184c808316eb3b514138f2.png
[62c2bf662de44fde9bbfcacb7492ce12.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/0fcbae96dad4405e928738ffc6fdbafc.png
[870ee3d7e4564506bedfd57d1d45b3cc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/6c3093395edd47b3a675f249be8c7245.png
[5a2c98d18afe4b10ac1e9ca1f068baea.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/c0bac7e1f9fc4481a1f507694b871d9b.png
[17f66d3c699e430999655b2ad28da7b6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/4fb29ab014ee4dfe8dab43257314f742.png
[a441d9d3df3240eea602617d96fe38c5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/fc98c20c8b714b7c9d0e3bb9a19b800b.png
[43a8cd2684664505abf8f6c5edd370b9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/0d8ef2d2fe914734bea0e8bcfc36e86f.png
[a5913cb4ecbb473986b64b374a9be2f6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/711604b473174b1db8373da2529e311d.png
[709f921615514f7a8a27e1e4b17b108e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/7dbd39393f394da292c9a8fafc6335b4.png
[d0f4f669cb5349d3ab0e19484d96375d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/1f70fb144ddd4a4682d5b1f12c4b10b7.png
[e55c65b223664e6dbed5961ecea0d270.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/c1771b049f834d22a751d1047531ffe2.png
[javadog.net]: https://www.javadog.net/
[b98f327f0a078f13b2b80f064914d622.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/1733490ad4e54fe68c848003df858971.png
[nvm_nodejs]: https://mp.weixin.qq.com/s/N6qwQpH-oIgFGSWIVDJ-2g
[SpringBoot_Iphone15_Selenium_Python]: https://mp.weixin.qq.com/s/JR1ZLhYTXw5C2Tr1BY86hg
[SpringBoot_uniapp_uview2_H5_APP]: https://mp.weixin.qq.com/s/g7AZOWLgW5vcCahyJDEPKA
[SpringBoot_uniapp_uview2]: https://mp.weixin.qq.com/s/t_qwF_HvkdW-6TI3sYUHrA
[SpringBoot]: https://mp.weixin.qq.com/s/fpkiNR2tj832a6VxZozwDg
[ChatGPT_ChatGPT]: https://mp.weixin.qq.com/s/9wEelbTN6kaChkCQHmgJMQ
[ChatGPT_SpringBoot_uniapp_uview2_OpenAI_ChatGPT]: https://mp.weixin.qq.com/s/b19J36Eo3-ba7bHbWzoZYQ
[e74f3636c05a430eab8819333fa004eb.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/c932371e3c8242c2bf4e7f343e4fbccd.jpeg