git提交注释规范插件

1、前言

为什么要注重代码提交规范?

在团队协作开发时,每个人提交代码时都会写 commit message。
每个人都有自己的书写风格,翻看我们组的git log, 可以说是五花八门,十分不利于阅读和维护。
一般项目开发都是多分支共存,master、develop、feature、hotfix、release等分支,在这么多分支中,我们会有一个稳定的master分支,但是我们需要将分支代码进行merge。存在规范的commit message可以帮助我们很轻松的合并代码以及发现问题。例如使用Jenkins自动化部署时,我们可以根据jenkins拉取commit message中的Closes issues验证BUG等。
因此,我们需要制定统一标准,促使团队形成一致的代码提交风格,更好的提高工作效率,成为一名有追求的工程师。

2、sourceTree提交注释模版配置

sourceTree - 偏好设置-提交
在这里插入图片描述
点击提交自动就出现
在这里插入图片描述

【提交类型】:feature、fix、docs、style、refactor、perf、test、build:、ci、chore、revert
【提交影响范围】:
【标题】: 
【功能描述】:
【不兼容变动】: 
【关闭 Issue】: 

3、idea提交注释模版配置

使用Git Commit Message Helper插件来辅助提交注释信息

3.1、安装Git Commit Message Helper

idea-preferences-Plugins-Browser repositories-搜索Git Commit Message Helper,如下图示:
在这里插入图片描述
安装完之后,重启idea即可完成配置。

3.2、配置模版信息

idea-preferences-Other Settings -GitCommitMessageHelper,如下图示:

在这里插入图片描述

type说明
type用于说明 commit 的类别,只允许使用下面标识

feature:新功能(feature)
fix:修补bug
docs:文档(documentation)
style: 格式(不影响代码运行的变动,空格,格式化,等等)
refactor:重构(即不是新增功能,也不是修改bug的代码变动)
perf: 性能 (提高代码性能的改变)
test:增加测试或者修改测试
build: 影响构建系统或外部依赖项的更改(maven,gradle,npm 等等)
ci: 对CI配置文件和脚本的更改
chore:对非 src 和 test 目录的修改
revert: Revert a commit

点击template

【提交类型】:#if($type)${type}#end
${newline}
【提交影响范围】:#if($scope)${scope}#end
${newline}
【标题】: #if($subject)${subject}#end
${newline}
【功能描述】:#if($body)${body}#end
${newline}
#if($changes)【不兼容变动】: ${changes}#end
${newline}
#if($closes)【关闭Issue】: ${closes}#end

3.3、插件使用
在Commit代码处,选择使用Git Commit Message Plugins插件,如下图所示,填写项详细含义请查看《插件详解》
在这里插入图片描述

在这里插入图片描述
总共分为3大部分,Header, Body,Footer详细讲解请看下节。
在这里插入图片描述
三、插件讲解
主要分为下面三个部分: Header, Body,Footer。

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

下面详细解释下个个部分的含义。

1、Header
Header的部分只有一行,包括三个字段: type(必需), scope(可选), subject(必需)

对应到idea插件上图的配置分别为 Header部分的:

type(必需) Type of change commit类别
scope(可选) Scope of this change commint影响的范围
subject(必需)**** Short description 简短的描述
1.1 type
type用于说明 commit 的类别,只允许使用下面标识

feat:新功能(feature)
fix:修补bug
docs:文档(documentation)
style: 格式(不影响代码运行的变动,空格,格式化,等等)
refactor:重构(即不是新增功能,也不是修改bug的代码变动)
perf: 性能 (提高代码性能的改变)
test:增加测试或者修改测试
build: 影响构建系统或外部依赖项的更改(maven,gradle,npm 等等)
ci: 对CI配置文件和脚本的更改
chore:对非 src 和 test 目录的修改
revert: Revert a commit

1.2 scope
scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

1.3 subject
subject是 commit 目的的简短描述,不超过50个字符。

以动词开头,使用第一人称现在时,比如change,而不是changed或changes
第一个字母小写
结尾不加句号(.)

2、Body
Body 部分是对本次 commit 的详细描述,可以分成多行。下面是一个范例。

如有必要,更详细的说明文本。包装它
大概72个字左右。后面的段落在空行之后。-要点也可以
-使用悬挂缩进

有一个注意点。

(1)应该说明代码变动的动机,以及与以前行为的对比。

3、Footer
Footer 部分只用于两种情况。

(1)不兼容变动

如果当前代码与上一个版本不兼容,则 Footer 部分以BREAKING CHANGE开头,后面是对变动的描述、以及变动理由和迁移方法。

(2)关闭 Issue

如果当前 commit 针对某个issue,那么可以在 Footer 部分关闭这个 issue 。

Closes #234

也可以一次关闭多个 issue 。

Closes #123, #245, #992

最后, 一个完整的commit message示例可能如下:
在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/pingmian/2604.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

关于CPP类中字符串成员初始化

直接看代码吧 #include <iostream> #include <string>/* A string is actually an object of the C++ Standard Library class string. This class is defined in header <string>, and the name string, like cout, belongs to namespace std. To enable …

kvm使用virt-clone克隆虚拟机

首先使用命令查看系统安装的所有虚拟机: virsh list --all然后使用如下命令进行虚拟机的克隆: virt-clone -o generic -n generic-1 -f /var/lib/libvirt/images/generic-1.qcow2-o后面要克隆的虚拟机名称 -n是新的虚拟机的名称 -f是生成的新的虚拟机磁盘文件路径(一般是/var…

Seal^_^【送书活动第2期】——《Flink入门与实战》

Seal^_^【送书活动第2期】——《Flink入门与实战》 一、参与方式二、本期推荐图书2.1 作者简介2.2 编辑推荐2.3 前 言2.4 本书特点2.5 内容简介2.6 本书适用读者2.7 书籍目录 三、正版购买 一、参与方式 评论&#xff1a;"掌握Flink&#xff0c;驭大数据&#xff0c;实战…

Ubuntu下部署gerrit+报错分析(超详细)

Ubuntu下部署gerrit代码平台 之前安装过几次 最后都在Apache代理这里失败了&#xff0c;如下图&#xff0c;总是gerrit.config与Apache2.config配置有问题&#xff0c;后面换了使用ngnix代理&#xff0c;简单多了 安装Mysql、gerrit、jdk、git 这一步也是非必须得&#xff0…

【c++】list类接口函数介绍与深度剖析模拟实现

&#x1f525;个人主页&#xff1a;Quitecoder &#x1f525;专栏&#xff1a;c笔记仓 朋友们大家好&#xff0c;本篇文章来到list有关部分&#xff0c;这一部分函数与前面的类似&#xff0c;我们简单讲解&#xff0c;重难点在模拟实现时的迭代器有关实现 目录 1.List介绍2.接…

Go 之为什么 rune 是 int32 的别名而不是 uint32 的别名

我对这个问题其实也是一直有疑问的&#xff0c;毕竟像 byte 都是 uint8 的别名。然后找了一些问答资料&#xff0c;不知道还没有没其他更好的解释。 范围足够 在 Unicode 字符集中&#xff0c;一个字符的码点范围是从 U0000 到 U10FFFF&#xff0c;共计 1114112 个码点&#…

转向敏捷财务规划,实现更快更自信的决策

随着数字化的到来&#xff0c;原本基于电子表格的时代正逐渐拉下帷幕&#xff0c;大部分企业开始摆脱依赖于电子表格进行计划、预算和预测的传统规划系统&#xff0c;寻求更符合当今市场要求的敏捷财务规划。但不得不承认&#xff0c;当下电子表格仍然是多数企业使用最广泛的工…

代码随想录-字符串 | 右旋字符串

代码随想录-字符串 | 7右旋字符串 卡码网 右旋字符串解题思路代码复杂度难点总结 卡码网 右旋字符串 题目链接 题目描述 字符串的右旋转操作是把字符串尾部的若干个字符转移到字符串的前面。给定一个字符串 s 和一个正整数 k&#xff0c;请编写一个函数&#xff0c;将字符串…

Wireshark数据包分析入门

Wireshark数据包分析 1. 网络协议基础1.1. 应传网数物&#xff08;应表会传网数物&#xff09; 2. 三次握手2.1. 第一次握手2.2. 第二次握手2.3. 第三次握手2.4. 三次握手后流量特征 3. 第一层---物理层&#xff08;以太网&#xff09;4. 第二层---数据链路层&#xff08;PPP L…

ele pls 表格行内样式超出隐藏

使用 模板实现方案&#xff1a; 实现效果&#xff1a; 相关样式&#xff1a;

【网络技术】【Kali Linux】Wireshark嗅探(十)IPv4和IPv6

往期 Kali Linux 上的 Wireshark 嗅探实验见博客&#xff1a; 【网络技术】【Kali Linux】Wireshark嗅探&#xff08;一&#xff09;ping 和 ICMP 【网络技术】【Kali Linux】Wireshark嗅探&#xff08;二&#xff09;TCP 协议 【网络技术】【Kali Linux】Wireshark嗅探&…

Jenkins CI/CD 持续集成专题四 Jenkins服务器IP更换

一、查看brew 的 services brew services list 二、编辑 homebrew.mxcl.jenkins-lts.plist 将下面的httpListenAddress值修改为自己的ip 服务器&#xff0c;这里我是用的本机的ip 三 、重新启动 jenkins-lts brew services restart jenkins-lts 四 浏览器访问 http://10.85…

Python技术:从入门到精通的指南

Python&#xff0c;作为一种高级编程语言&#xff0c;因其简洁的语法和强大的功能而广受开发者喜爱。它不仅适用于初学者快速上手&#xff0c;也能满足专业开发者的复杂需求。 Python语言的特点 简洁易读 Python的语法接近英语&#xff0c;易于编写和阅读&#xff0c;是初学者…

小米金融警示非法集资风险 助力消费者守护“钱袋子”

随着公安机关对电信网络诈骗打击力度的持续加大&#xff0c;不法分子的诈骗手段也在不断翻新&#xff0c;其隐蔽性和欺骗性日益增强。根据《2022年度反诈报告》数据显示&#xff0c;投资理财类诈骗已成为当前黑灰产活动的主要类型之一&#xff0c;给广大金融消费者带来了严重的…

孩子如何才能学好python

Python是一种高级编程语言&#xff0c;因为其简单易学、功能强大和易于阅读的语法&#xff0c;已经成为了最受欢迎的编程语言之一。对于孩子来说&#xff0c;学习Python不仅可以提高他们的计算机技能&#xff0c;还可以为他们未来的职业生涯打下基础。下面是一些学习Python的建…

python 常用库

python 常用库 以下是对每个包的作用的简要解释&#xff1a; absl-py&#xff1a;是 Abseil Python 库&#xff0c;提供了一些实用的工具和功能。accelerate&#xff1a;用于加速数据处理。addict&#xff1a;用于操作嵌套字典。aiofiles&#xff1a;支持异步文件操作。aiohtt…

redis7安装与配置

一、下载 通过 redis官网 或者 redis中文网 下载。 以下是 redis 相关文档资料链接&#xff1a; redis源码地址 redis在线测试 redis命令参考 redis中文文档 历史发布版本的源码地址 二、版本命名规则 Redis从发布到现在&#xff0c;已经有十余年的时光了&#xff0c;…

Redis 大KEY/慢查询问题的排查和解决

1.排查大KEY/慢查询问题 &#xff08;1&#xff09;设置慢查询参数 slowlog-log-slower-than 10000 --设置慢查询的时间阀值&#xff0c;单位微秒 slowlog-max-len 128 --设置慢查询FIFO队列的长度 &#xff08;2&#xff09;模拟大KEY public class Re…

云原生Service Mesh服务网格简单介绍

serviceMesh是什么 Service Mesh是一个用于处理服务间通信的基础设施层&#xff0c;旨在实现云原生应用复杂服务拓扑中的可靠请求传递。其基本构成是一组与应用一起部署的轻量级网络代理&#xff0c;这些代理对应用来说是透明的。Service Mesh通过统一的方式来控制和处理服务间…

C++期末考试注意点2

函数重载和虚函数处理&#xff1a;函数重载处理的是同一层次上的同名函数问题。虚函数处理的是不同派生层次上的同名函数问题。同一类族的虚函数的首部是相同的&#xff0c;而函数重载时函数的首部是不同的(参数个数或类型不同)。虚函数&#xff1a; (1)只能用virtual声明类的…