当前位置： 首页 > news >正文

Git Commit Message规范

news 2026/5/13 21:46:31

概述

Git commit message规范是一种良好的实践，可以帮助开发团队更好地理解和维护代码库的历史记录。它可以提高代码质量、可读性和可维护性。下面是一种常见的Git commit message规范，通常被称为"Conventional Commits"规范：

一、Commit message 的格式

每次提交，Commit message 都包括三个部分：Header，Body 和 Footer。

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

其中，Header、针对feat和fix类型的提交内容 Body 是必需的。 不管是哪一个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免自动换行影响美观。

1.1 Header

Header部分只有一行，包括三个字段： type（必需）、scope（必需）和subject（必需）。

（1）type

type用于说明 commit 的类别，只允许使用下面7个标识。

  • feat：新功能（feature）
  • fix：修补bug
  • docs：文档（documentation）
  • style： 代码样式的变更（例如，格式化）（不影响代码运行的变动）
  • refactor：重构（即不是新增功能，也不是修改bug的代码变动）
  • test：添加或修改测试
  • build：构建过程或辅助工具的变动

补充：

  • chore: 构建工具、辅助工具或其他无关紧要的任务
  • perf: 改进性能的代码更改
  • revert: 撤销以前的提交

（2）scope

scope用于说明 commit 影响的范围，比如指标模板、规则上下线等等，视项目不同而不同。

（3）subject

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

  1. 以动词开头，使用第一人称现在时，比如change，而不是changed或changes
  2. 第一个字母小写
  3. 结尾不加句号（.）

1.2 Body

Body 部分是对本次 commit 的详细描述，可以分成多行。

  1. 需要简要的列出各种正向或者反向的测试场景，测试通过，填pass。
  2. 关闭的Issue(References) (可选): 如果此提交与某个问题（Issue）相关联，可以在提交消息中引用该问题。例如，Fixes #123 或 Closes #456。
  3. 增加修改人信息

二、例子

2.1 feat例子

feat(规则上下线、构建、生效、仿真生效): 添加规则上下线功能 1. 规则上下线主流程，引擎正常订阅，fldl生成正常。 pass
2. 规则上下线，传入不存在的规则编号，异常提示。 pass提交人：xxx

2.2 fix例子

fix(模型模块): 模型测试失败1. 导入mar模型，包含衍生字段。 pass
2. 导入mar模型，不包含衍生字段。 pass提交人：xxx

2.3 关闭的Issue例子

feat(auth): add user authentication feature- Implemented user login and registration
- Added user profile page
- Fixes #123, Closes #456提交人：xxx

使用这种规范的好处在于，它使提交消息更加一致和易于搜索。同时，它还允许自动化工具从提交消息中提取信息，如生成发布日志或自动化版本号管理。

插件推荐

idea可以安装代码提交规范的插件。

1、安装插件

在这里插入图片描述

2、提交时选择插件提交

在这里插入图片描述

在这里插入图片描述

参考

Git Commit Message规范
https://blog.csdn.net/LBWNB_Java/article/details/126776372

相关文章：

Git Commit Message规范

概述 Git commit message规范是一种良好的实践&#xff0c;可以帮助开发团队更好地理解和维护代码库的历史记录。它可以提高代码质量、可读性和可维护性。下面是一种常见的Git commit message规范&#xff0c;通常被称为"Conventional Commits"规范&#xff1a; 一…...

编程日记 2023/10/16 6:43:11

Linux网络编程系列之UDP广播

Linux网络编程系列 &#xff08;够吃&#xff0c;管饱&#xff09; 1、Linux网络编程系列之网络编程基础 2、Linux网络编程系列之TCP协议编程 3、Linux网络编程系列之UDP协议编程 4、Linux网络编程系列之UDP广播 5、Linux网络编程系列之UDP组播 6、Linux网络编程系列之服务器编…...

编程日记 2023/10/16 6:42:09

spring中事务相关面试题（自用）

1 什么是spring事务 Spring事务管理的实现原理是基于AOP&#xff08;面向切面编程&#xff09;和代理模式。Spring提供了两种主要的方式来管理事务&#xff1a;编程式事务管理和声明式事务管理。 声明式事务管理&#xff1a; Spring的声明式事务管理是通过使用注解或XML配置来…...

编程日记 2023/10/16 6:41:08

09 | JpaSpecificationExecutor 解决了哪些问题

QueryByExampleExecutor用法 QueryByExampleExecutor&#xff08;QBE&#xff09;是一种用户友好的查询技术&#xff0c;具有简单的接口&#xff0c;它允许动态查询创建&#xff0c;并且不需要编写包含字段名称的查询。 下面是一个 UML 图&#xff0c;你可以看到 QueryByExam…...

编程日记 2023/10/16 6:40:06

Linux命令(93)之su

linux命令之su 1.su介绍 linux命令su用于变更为其它使用者的身份&#xff0c;如root用户外&#xff0c;需要输入使用者的密码 2.su用法 su [参数] user su参数 参数说明-c <command>执行指定的命令&#xff0c;然后切换回原用户-切换到目标用户的环境变量 3.实例 3…...

编程日记 2023/10/16 6:39:05

1.HTML-HTML解决中文乱码问题

题记 下面是html文件解决中文乱码的方法 方法一 在 HTML 文件的 <head> 标签中添加 <meta charset"UTF-8">&#xff0c;确保文件以 UTF-8 编码保存 <head> <meta charset"UTF-8"> <!-- 其他标签和内容 --> </head> --…...

编程日记 2023/10/16 6:38:05

Vue3 + Nodejs 实战 ，文件上传项目--实现拖拽上传

目录 1.拖拽上传的剖析 input的file默认拖动 让其他的盒子成为拖拽对象 2.处理文件的上传 处理数据 上传文件的函数 兼顾点击事件 渲染已处理过的文件 测试效果 3.总结 博客主页&#xff1a;専心_前端,javascript,mysql-CSDN博客 系列专栏&#xff1a;vue3nodejs 实战-…...

编程日记 2023/10/16 6:37:04

Windows：VS Code IDE安装ESP-IDF【保姆级】

物联网开发学习笔记——目录索引 参考&#xff1a; VS Code官网&#xff1a;Visual Studio Code - Code Editing. Redefined 乐鑫官网&#xff1a;ESP-IDF 编程指南 - ESP32 VSCode ESP-ID Extension Install 一、前提条件 Visual Studio Code IDE安装ESP-IDF扩展&#xf…...

编程日记 2023/10/16 6:36:03

Hadoop3教程（十一）：MapReduce的详细工作流程

文章目录 &#xff08;94&#xff09;MR工作流程Map阶段Reduce阶段 参考文献 &#xff08;94&#xff09;MR工作流程 本小节将展示一下整个MapReduce的全工作流程。 Map阶段 首先是Map阶段&#xff1a; 首先&#xff0c;我们有一个待处理文本文件的集合&#xff1b; 客户端…...

编程日记 2023/10/16 6:35:02

测试中Android与IOS分别关注的点

目录 1、自身不同点 2、测试注重点 3、其他测试点 主要从本身系统的不同点、系统造成的不同点、和注意的测试点做总结 1、自身不同点 研发商&#xff1a;Adroid是google公司做的手机系统&#xff0c;IOS是苹果公司做的手机系统 　　开源程度&#xff1a;Android是开源的&a…...

编程日记 2023/10/16 6:34:01

NLG（自然语言生成）评估指标介绍

诸神缄默不语-个人CSDN博文目录 本文介绍自然语言生成任务中的各种评估指标。 因为我是之前做文本摘要才接触到这一部分内容的&#xff0c;所以本文也是文本摘要中心。 持续更新。 文章目录 1. 常用术语2. ROUGE (Recall Oriented Understudy for Gisting Evaluation)1. 计算…...

编程日记 2023/10/16 6:33:00

苍穹外卖(七) Spring Task 完成订单状态定时处理

Spring Task 完成订单状态定时处理, 如处理支付超时订单 Spring Task介绍 Spring Task 是Spring框架提供的任务调度工具&#xff0c;可以按照约定的时间自动执行某个代码逻辑。 应用场景: 信用卡每月还款提醒 火车票售票系统处理未支付订单 入职纪念日为用户发送通知 点外…...

编程日记 2023/10/16 6:30:57

【探索Linux】—— 强大的命令行工具 P.11（基础IO，文件操作）

阅读导航 前言一、C语言的文件操作二、C的文件操作三、Linux系统文件操作&#xff08;I/O接口&#xff09;1. open()⭕传入多个打开方式&#xff08;按位或操作将不同的标志位组合在一起&#xff09; 2. write()3. read()4. close()5. lseek() 温馨提示 前言 前面我们讲了C语言…...

编程日记 2023/10/16 6:29:56

前端练习项目(附带页面psd图片及react源代码)

一、前言 相信很多学完前端的小伙伴都想找个前端项目练练手&#xff0c;检测自己的学习成果。但是现在很多项目市面上都烂大街了。今天给大家推荐一个全新的项目——电子校园 项目位置&#xff1a;https://github.com/v5201314/eSchool 二、项目介绍(部分页面展示)&#xff…...

编程日记 2023/10/16 6:28:55

【从零开始学习Redis | 第三篇】在Java中操作Redis

前言&#xff1a; 本文算是一期番外&#xff0c;介绍一下如何在Java中使用Reids &#xff0c;而其实基于Java我们有很多的开源框架可以用来操作redis&#xff0c;而我们今天选择介绍的是其中比较常用的一款&#xff1a;Spring Data Redis 目录 前言&#xff1a; Spring Data…...

编程日记 2023/10/16 6:27:54

vim、gcc/g++、make/Makefile、yum、gdb

vim、gcc/g、make/Makefile、yum、gdb 一、Linux编辑器vim1、简介2、三种模式的概念&#xff08;1&#xff09;正常/普通/命令模式(Normal mode)&#xff08;2&#xff09;插入模式(Insert mode)&#xff08;3&#xff09;末行/底行模式(last line mode) 3、三种模式的切换4、正…...

编程日记 2023/10/16 6:26:52

2022最新版-李宏毅机器学习深度学习课程-P13 局部最小值与鞍点

一、优化失败的原因 局部最小值&#xff1f;鞍点&#xff1f; 二、数学推导分析 用泰勒公式展开 一项与梯度&#xff08;L的一阶导&#xff09;有关&#xff0c;一项与海赛矩阵&#xff08;L的二阶导&#xff09;有关 海瑟矩阵 VTHV通过海瑟矩阵的性质可以转为判断H是否是正…...

编程日记 2023/10/16 6:25:51

ARM架构的基本知识

ARM两种授权 体系结构授权, 一种硬件规范, 用来约定指令集, 芯片内部体系结构(内存管理, 高速缓存管理), 只约定每一条指令的格式, 行为规范, 参数, 客户根据这个规范自行设计与之兼容的处理器处理IP授权, ARM公司根据某个版本的体系结构设计处理器, 再把处理器设计方案授权给…...

编程日记 2023/10/16 6:23:48

网络安全（黑客技术）——如何高效自学

前言 前几天发布了一篇 网络安全&#xff08;黑客&#xff09;自学 没想到收到了许多人的私信想要学习网安黑客技术&#xff01;却不知道从哪里开始学起&#xff01;怎么学&#xff1f;如何学&#xff1f; 今天给大家分享一下&#xff0c;很多人上来就说想学习黑客&#xff0c…...

编程日记 2023/10/16 6:22:48

云原生场景下高可用架构的最佳实践

作者&#xff1a;刘佳旭&#xff08;花名&#xff1a;佳旭&#xff09;&#xff0c;阿里云容器服务技术专家 引言 随着云原生技术的快速发展以及在企业 IT 领域的深入应用&#xff0c;云原生场景下的高可用架构&#xff0c;对于企业服务的可用性、稳定性、安全性越发重要。通…...

编程日记 2023/10/16 6:20:45

如何免费解锁Cursor Pro功能：开源工具完整使用指南

如何免费解锁Cursor Pro功能&#xff1a;开源工具完整使用指南 【免费下载链接】cursor-free-vip [Support 0.45]&#xff08;Multi Language 多语言&#xff09;自动注册 Cursor Ai &#xff0c;自动重置机器ID &#xff0c; 免费升级使用Pro 功能: Youve reached your trial …...

编程新知 2026/5/13 21:20:42

用Fiddler和Proxifier抓包分析易游网络验证API，手把手教你模拟合法请求

网络验证API抓包与模拟请求实战指南 在当今数字化产品生态中&#xff0c;网络验证机制已成为软件授权管理的核心组件。不同于传统的本地验证方式&#xff0c;网络验证通过远程API交互实现更高安全性的许可控制&#xff0c;这也使得协议层分析成为理解其工作原理的关键切入点。对…...

编程新知 2026/5/13 21:18:41

终极指南：如何使用Gulf of Mexico轻松实现TCP/UDP网络通信

终极指南&#xff1a;如何使用Gulf of Mexico轻松实现TCP/UDP网络通信 【免费下载链接】GulfOfMexico perfect programming language 项目地址: https://gitcode.com/GitHub_Trending/dr/GulfOfMexico Gulf of Mexico&#xff08;原DreamBerd&#xff09;是一种创新的编…...

编程新知 2026/5/13 20:11:58

别再手动导网表了！巧用OrCAD Capture与Allegro PCB Editor联动，实现原理图变更一键同步

别再手动导网表了&#xff01;巧用OrCAD Capture与Allegro PCB Editor联动&#xff0c;实现原理图变更一键同步 在PCB设计领域&#xff0c;效率与准确性往往决定着项目成败。当工程师面对频繁的原理图修改时&#xff0c;传统的手动导出-导入网表流程不仅耗时费力&#xff0c;还…...

编程新知 2026/5/13 19:44:00

通达信缠论分析插件：如何用开源工具实现智能技术分析

通达信缠论分析插件&#xff1a;如何用开源工具实现智能技术分析 【免费下载链接】Indicator 通达信缠论可视化分析插件 项目地址: https://gitcode.com/gh_mirrors/ind/Indicator 缠论作为技术分析的重要理论体系&#xff0c;其复杂的线段划分和中枢识别让许多交易者望…...

编程新知 2026/5/13 19:00:40

AnyFlip下载器终极指南：3分钟快速将在线翻页书转为PDF

AnyFlip下载器终极指南&#xff1a;3分钟快速将在线翻页书转为PDF 【免费下载链接】anyflip-downloader Download anyflip books as PDF 项目地址: https://gitcode.com/gh_mirrors/an/anyflip-downloader 你是否在AnyFlip上发现了心仪的电子书&#xff0c;却苦于无法下…...

编程新知 2026/5/13 18:08:31

浏览器扩展开发实战：KeepChatGPT会话保持原理与实现

1. 项目概述&#xff1a;一个浏览器扩展的诞生与使命 最近在和一些做AI应用开发的朋友交流时&#xff0c;大家普遍反映了一个痛点&#xff1a;在使用一些大型语言模型&#xff08;LLM&#xff09;的在线服务时&#xff0c;对话经常会被意外中断。这种中断可能源于网络波动、服…...

编程新知 2026/5/13 17:52:47

5分钟快速上手：FigmaCN免费中文界面插件终极指南

5分钟快速上手&#xff1a;FigmaCN免费中文界面插件终极指南 【免费下载链接】figmaCN 中文 Figma 插件&#xff0c;设计师人工翻译校验 项目地址: https://gitcode.com/gh_mirrors/fi/figmaCN 还在为Figma的英文界面而烦恼吗&#xff1f;想要专注于设计创意却被语言障碍…...

编程新知 2026/5/13 17:34:27

Elasticsearch管理利器：es-client全方位指南与实战技巧

Elasticsearch管理利器&#xff1a;es-client全方位指南与实战技巧 【免费下载链接】es-client elasticsearch客户端&#xff0c;issue请前往码云&#xff1a;https://gitee.com/qiaoshengda/es-client 项目地址: https://gitcode.com/gh_mirrors/es/es-client 你是否曾…...

编程新知 2026/5/13 16:13:53

生物 -- 神经系统（三）

1、髓鞘髓鞘是包裹在神经细胞轴突外层的绝缘膜&#xff0c;主要由脂质和蛋白质构成&#xff0c;起到加速神经信号传导、绝缘防漏电以及保护和修复神经的作用‌。你可以把它想象成电线外的绝缘皮&#xff0c;确保电流&#xff08;即神经信号&#xff09;高效、准确地传输。核心功…...

编程新知 2026/5/13 15:48:20