Git Commit Message 规范

已于 2024-06-01 09:22:50 修改
阅读量444 收藏 6
点赞数 5
文章标签： java 后端 spring boot git
于 2024-05-30 11:38:28 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/qq_51720083/article/details/139319826
版权

Git Commit Message 规范

在git commit时，要提交变动信息，但是没有固定的格式，会很乱并让人难以理解代码的变动，强迫症患者有福啦！

格式

<type>(<scope>): <subject>
<空行>
<body>
<空行>
<footer>
  • type：变动类型，取值见下文
  • scope：修改的代码范围，可写包名，范围较大写 *
  • subject：简短描述主要变动
  • body(可省略)：详细描述变动
  • footer(可省略)：不知道干啥的，不咋用

举个例子

refactor(result): 修改Result类以简化返回结果

- 删除带有泛型数据的success方法
- 删除带有错误消息的error方法
- 保留只返回code的success和error方法

type取值

  • feat：新功能
  • fix：bug
  • docs：注释变动
  • style： 格式（不影响代码运行的变动、空格、格式化等等）
  • refactor：重构（即不是新增功能，也不是修改bug的代码变动）
  • perf：性能
  • test：测试或者修改测试
  • build：影响构建系统或外部依赖项的更改(maven,gradle,npm 等等)
  • ci：对CI配置文件和脚本的更改
  • chore：对非 src 和 test 目录的修改
  • revert：撤销一个提交

IDEA插件：Git Commit Template Check

【知识整理】Git Commit Message 规范
李木
02-23 3024
前面咱们整理过Code Review 一文，提到了 Review 的重要性，已经同过gitlab进行CodeReview 的方式，那么本文详细说明一下对CodeReivew非常重要的Git Commit Message 规范。我们在每次提交代码时，都需要编写 Commit Message，否则是不允许提交的。书写好的 Commit Message 能大大提高代码维护的效率。避免开发人员在项目中群魔乱舞，搞得代码一团糟，搞的项目就被糟践了。且开发日后的维护，都将是灾难。
Git Commit提交规范总结
拾年一剑 的专栏
02-27 6858
团队协作中，规范的Git提交记录，使提交历史明确可追溯，有助于更好的协作，方便后期代码的开发和维护
commit-template-idea-plugin：用于IntelliJ的Git提交模板插件
02-03
用于IntelliJ的Git提交模板插件 该插件允许使用以下模板创建提交消息： <type>(<scope>): <subject> <BLANK> <body> <BLANK> <footer> 从角项目的贡献准则 。 安装 直接从IDE插件管理器安装（文件>设置>插件>浏览器存储库> Git提交模板） 用法 伙伴 执照 根据Apache许可版本2.0（“许可”）许可； 除非遵守许可，否则不得使用此文件。 您可以在以下位置获得许可的副本： 除非适用法律要求或以书面形式同意，否则根据“许可”分发的软件将按“原样”分发，而没有任何明示或暗示的保证或条件。 有关许可下特定的
好用的IDEA插件之Git Commit Template
dongdong199033的博客
03-24 4547
Git Commit Template是一款免费的IntelliJ IDEA插件，用于提供Git提交模板。该插件可以帮助开发者编写规范的Git提交信息，提高代码管理效率。
git commit messege 模板设置 (规范化管理git)
最新发布
m0_57249200的博客
03-11 431
git 提交信息模板设置，规范化git commit 记录
git commit template
weixin_34137799的博客
07-29 176
https://www.zhihu.com/question/27462267/answer/204658544 https://gist.github.com/adeekshith/cd4c95a064977cdc6c50 # &lt;type&gt;: (If applied, this commit will...) &lt;subject&gt; (Max 50 char) # ...
IDEA插件Git Commit Template
浮夸ㄟ
09-30 325
IDEA插件Git Commit Template type：用于说明commit的类别，常用的标识如下： feat ：新功能（feature） fix ：修补BUG docs ：文档（documentation） style ：格式（不影响代码运行的变动,空格,格式化,等等） refactor ：重构（即不是新增功能，也不是修改bug的代码变动 perf ：性能 (提高代码性能的改变) test ：增加测试或者修改测试 build ：影响构建系统或外部依赖项的更改(mav
后端必备的 Git Commit Message规范指南-直接食用
a0987654321abc的博客
08-06 378
IDEA中规范使用Git Commit Message，包括插件安装、使用和讲解，通过git hooks进行校验。
git commit message 规范
06-06
Git commit message规范是指Git版本控制系统中提交代码时，对于commit message的书写规范化。这样可以让每个commit message都更加清晰明确，便于开发者和其他项目成员理解和维护代码。常见的规范包括commit message...
leetcode2-git-commit-message-helper:一个帮助git代码提交规范的JetBrains系列插件，支持IDEA、
06-29
git-commit-message-helper 本插件是源idea插件的升级版，增加了一系列个性化配置。 安装 直接从 IDE 插件管理器安装（文件 > 设置 > 插件 > 浏览器存储库 > Git Commit Message Helper） 用法 如果要更改提交类型，...
idea git commit插件
03-24
idea commit 模板插件
Commit Template IDEA 插件教程
gitblog_00894的博客
08-16 1022
Commit Template IDEA 插件教程 commit-template-idea-pluginGit commit template Plugin for IntelliJ项目地址:https://gitcode.com/gh_mirrors/co/commit-template-idea-plugin 1. 项目介绍 Commit Template IDEA Plugin 是一个 ...
git commit添加模板
酒无忧的博客
10-17 1258
此时当我们输入git commit -s时就会自动创建如下commit内容。如果想在commit中添加作者签名，使用**-s**指令，如下。
idea git commit template定制
liliang_ICT的博客
04-26 733
链接：https://pan.baidu.com/s/1InRraWHq3HFz4DrrEcYqQA。
idea的git的规范化提交插件
qq_30624649的博客
02-13 4061
如何在idea中使用git提交代码的时候更加规范化？
idea中使用git进行commit操作
m0_68201836的博客
09-03 3148
idea中使用git进行commit操作
git commit 模板，让代码提交更规范
android_sniper的专栏
01-29 1549
大家有没有遇到过，git log 查看代码提交记录的时候每个人都有自己的风格，有的详细，有的简单到让你摸不着头脑。 那么如何让大家书写规范的提交记录？当然靠宣贯和自觉肯定是不行的，过了一段时间又恢复原样了。 这里分享一个最佳实践，强制大家提交代码时按照规范的模板来写。这就要用到.git-commit-template了，我是这么做的： xxx@CNFFSAPP0108:~$ cat .git-commit-template 问题来源及描述: 所属模块: 问题原因: 解决方法: 项目平台:T7/C490
IDEA git提交规范插件（git commit template插件）
热门推荐
阿甘兄
08-22 2万+
概述 使用git commit template可以规范我们在IDEA提交代码是的注释规范，使用效果如下： 首先提交时，点击如下图标： 填写提交内容影响类型、影响范围、短注释、长注释等： 填写完后，自动生成模板： 安装步骤 打开settings下的plugin里搜索git commit template插件： 安装完后重启IDEA就可以愉快的使用了。 ...
idea --Git Commit Template插件
qq_38619449的博客
08-29 2424
Git Commit Template是一款免费的IntelliJ IDEA插件，用于提供Git提交模板。ci 持续集成方面的更改。feat 功能feature的意思，也是最常用的。当你的功能有变更的时候，都可以采用这种类型的type。指的是代码结构的调整，比如使用了一些设计模式重新组织了代码。build 影响编译的一些更改，比如更改了maven插件、增加了npm的过程等。style 代码格式调整，比如执行了format、更改了tab显示等。test 这个简单，就是增加了单元测试和自动化相关的代码。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值