Git Commit 之道：规范化 Commit Message 写作指南

1 commit message 规范

commit message格式都包括三部分：Header，Body和Footer

<type>(<scope>): <subject><body><footer>

Header是必需的，Body和Footer则可以省略

1.1 Header

  1. Type（必需）

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

    • feat：新功能（Feature）

      "feat"用于表示引入新功能或特性的变动。这种变动通常是在代码库中新增的功能，而不仅仅是修复错误或进行代码重构。

    • fix/to：修复bug。这些bug可能由QA团队发现，或由开发人员在开发过程中识别。

      • fix关键字用于那些直接解决问题的提交。当创建一个包含必要更改的提交，并且这些更改能够直接修复已识别的bug时，应使用fix。这表明提交的代码引入了解决方案，并且问题已被立即解决。
      • to关键字则用于那些部分处理问题的提交。在一些复杂的修复过程中，可能需要多个步骤或多次提交来完全解决问题。在这种情况下，初始和中间的提交应使用to标记，表示它们为最终解决方案做出了贡献，但并未完全解决问题。最终解决问题的提交应使用fix标记，以表明问题已被彻底修复。

    • docs：文档（Documentation）

      “docs” 表示对文档的变动，这包括对代码库中的注释、README 文件或其他文档的修改。这个前缀的提交通常用于更新文档以反映代码的变更，或者提供更好的代码理解和使用说明。

    • style: 格式（Format）

      “style” 用于表示对代码格式的变动，这些变动不影响代码的运行。通常包括空格、缩进、换行等风格调整。

    • refactor：重构（即不是新增功能，也不是修改bug的代码变动）

      “refactor” 表示对代码的重构，即修改代码的结构和实现方式，但不影响其外部行为。重构的目的是改进代码的可读性、可维护性和性能，而不是引入新功能或修复错误。

    • perf: 优化相关，比如提升性能、体验

      “perf” 表示与性能优化相关的变动。这可能包括对算法、数据结构或代码实现的修改，以提高代码的执行效率和用户体验。

    • test：增加测试

      “test” 表示增加测试，包括单元测试、集成测试或其他类型的测试。

    • chore：构建过程或辅助工具的变动

      “chore” 表示对构建过程或辅助工具的变动。这可能包括更新构建脚本、配置文件或其他与构建和工具相关的内容。

    • revert：回滚到上一个版本

      “revert” 用于回滚到以前的版本，撤销之前的提交。

    • merge：代码合并

      “merge” 表示进行代码合并，通常是在分支开发完成后将代码合并回主线。

    • sync：同步主线或分支的Bug

      “sync” 表示同步主线或分支的 Bug，通常用于解决因为合并而引入的问题。

  2. Scope（可选）

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

    例如修改了Dao或者Controller，则可以添加表示这些范围受到影响，这有助于更清晰地理解提交的变更影响范围。例如：

    feat(Controller): 添加用户登录功能

    这个提交消息中，Controller 是 scope，表示这次提交影响了控制层。

    fix(DataAccess): 修复数据查询逻辑

    这个提交消息中，DataAccess 是 scope，表示这次提交影响了数据访问层。

    如果你的修改影响了不止一个scope，你可以使用*代替。

  3. Subject（必需）

    subject是 commit 目的的简短描述，不超过50个字符。规范如下：

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

    例如：

    feat(UserAuth): implement user authentication

    这个提交消息中，implement user authentication 是 subject，简洁明了地描述了引入用户认证功能的目的。

    fix(Validation): correct input validation logic

    这个提交消息中，correct input validation logic 是 subject，清晰地说明了修复输入验证逻辑的目的。

1.2 Body

Body 部分是对本次 commit 的详细描述，可以分成多行。Body编写有两个注意点。

  1. 使用第一人称现在时，比如使用change而不是changed或changes。这有助于使描述更加直观和连贯，增强可读性。
  2. 应该说明代码变动的动机，以及与以前行为的对比。 Body 部分不仅仅是描述代码的变动，还应该解释为什么进行这个变动，以及与之前的代码行为相比有哪些改进。这有助于其他开发者更好地理解代码变更的背后动机和意图。

1.3 Footer

Footer 部分只用于两种情况。

  1. 不兼容变动

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

  2. 关闭 Issue

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

    Closes #234

    也可以一次关闭多个 issue 。

    Closes #123, #245, #992

1.4 示例

  • 添加用户配置文件编辑功能

    feat(UserProfile): add user profile editing featureThis commit introduces a new feature that allows users to edit their profiles
directly from the user interface. The motivation behind this change is to
enhance user interaction and provide a more seamless experience.Previously, users had to navigate to a separate editing page to update their
profile information. With this new feature, users can now make changes
efficiently from their profile page, eliminating unnecessary steps in the
workflow.Changes included in this commit:
- Added a new 'Edit Profile' button on the user profile page.
- Implemented frontend components for profile editing.
- Updated backend API to handle profile updates securely.By streamlining the profile editing process, we aim to improve overall user
satisfaction and make our application more user-friendly. This enhancement is
in response to user feedback, addressing the need for a more intuitive and
accessible way to modify profile details.Closes #234

  • 纠正输入验证逻辑

    fix(Validation): correct input validation logicThis commit addresses an issue related to input validation logic in the
application. Previously, the validation process was not handling certain edge
cases correctly, leading to unexpected behavior in specific scenarios.To resolve this issue, the validation logic has been revised to properly
handle various input scenarios. This ensures that user input is thoroughly
validated, reducing the likelihood of errors in the application.The changes made in this commit include:
- Correcting boundary checks for user input.
- Improving error messages for better user guidance.These adjustments align with our commitment to delivering a robust and
reliable application experience.Closes #123

  • 优化数据库查询

    refactor(DataAccess): optimize database queriesIn this commit, we have refactored the data access layer to optimize database
queries and improve overall system performance. The existing query structure
was identified as a bottleneck during performance testing, leading to longer
response times.Changes made in this commit:
- Reorganized database queries to reduce redundant operations.
- Utilized database indexing for faster data retrieval.By optimizing database queries, we expect to see a significant improvement in
system responsiveness and user experience.Closes #456

2 git commit 工具

2.1 commitizen

Commitizen是一个强大的工具，用于撰写合格的 Git 提交消息。使用 Commitizen 可以帮助团队遵循统一的提交消息规范，使提交历史更加清晰和易读。

首先，通过以下命令全局安装 Commitizen：

npm install -g commitizen

然后，在项目目录里，运行下面的命令，使其支持 Angular 的 Commit message 格式。

commitizen init cz-conventional-changelog --save --save-exact

这个命令会配置项目，使其支持 Angular 规范的 Commit Message。在执行命令时，你可以选择其他预定义的规范或者创建自定义规范。

之后，当你执行 git commit 命令时，将其替换为 git cz。此时，Commitizen 将引导你通过一个交互式的界面，以生成符合规范的 Commit Message。

img

在这个交互式界面中，你可以选择提交的类型（feat、fix、docs 等）、影响的范围（scope）、简短的描述（subject）以及其他相关信息。通过这种方式，可以确保提交消息符合规范，并提供了更多的上下文信息，便于他人理解变更的目的。

使用 Commitizen 和规范化的提交消息格式，有助于提高代码库的可读性，方便生成自动化的变更日志，并促使开发者更注重写出清晰、明确的提交消息。

2.2 commitlint

commitlint是一个用于检查提交消息是否符合指定规范的工具。它可以帮助团队确保 Git 提交消息的一致性和规范性，尤其是当项目采用类似 Angular Commit Message Conventions 的规范时。

  1. 安装 Commitlint

    首先，你需要安装 commitlint 及其相关的配置和规则。通常，@commitlint/config-conventional 是与 Angular 规范兼容的配置。

    npm install --save-dev @commitlint/config-conventional @commitlint/cli

  2. 配置 Commitlint

    在项目根目录下创建 commitlint.config.js 文件，并添加如下内容：

    module.exports = {extends: ['@commitlint/config-conventional'],
};

    这个配置文件使用了 @commitlint/config-conventional 中预定义的规则，确保符合常见的提交规范。

  3. 配置Git钩子

    你可以使用 Husky 钩子工具来在提交前运行 commitlint。首先，安装 Husky：

    bashCopy code
npm install --save-dev husky

    然后，在 package.json 中添加以下配置：

    jsonCopy code
"husky": {"hooks": {"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"}
}

    这样配置后，每次提交前都会自动运行 commitlint 检查提交消息是否符合规范。

3 生成Change log

如果你的所有 Commit 都符合 Angular 格式，那么发布新版本时， Change log 就可以用脚本自动生成（例1，例2）。

在这里插入图片描述

生成的文档包括以下三个部分。

  • New features（新特性）
  • Bug fixes（bug修复）
  • Breaking changes（重大变更）

每个部分都会罗列相关的 commit ，并且有指向这些 commit 的链接。当然，生成的文档允许手动修改，所以发布前，你还可以添加其他内容。

conventional-changelog 就是生成 Change log 的工具，运行下面的命令即可。

npm install -g conventional-changelog
cd my-project
conventional-changelog -p angular -i CHANGELOG.md -w

上面命令不会覆盖以前的 Change log，只会在CHANGELOG.md的头部加上自从上次发布以来的变动。

如果你想生成所有发布的 Change log，要改为运行下面的命令。

conventional-changelog -p angular -i CHANGELOG.md -w -r 0

为了方便使用，可以将其写入package.json的scripts字段。

{"scripts": {"changelog": "conventional-changelog -p angular -i CHANGELOG.md -w -r 0"}
}

以后，直接运行下面的命令即可。

npm run changelog

这个自动化流程不仅简化了 Change log 的生成过程，还确保了记录项目变更的一致性和准确性。生成的文档会按照新特性、bug 修复和重大变更等分类，方便用户快速了解每个版本的变更情况。

4 参考资料

  1. 如何规范你的Git commit？—阿里云开发者
  2. Commit message 和 Change log 编写指南—阮一峰的网络日志

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

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

相关文章

高级项目管理总结

高级项目管理总结

目录 一、背景介绍二、思路&方案三、过程1.升维思考2.结构化3.心理、知识阶段检验4.微观 四、总结 一、背景介绍 天性对学习对考试充满敌意的我&#xff0c;转变为依赖学习谋生&#xff0c;再到后来书中自有黄金屋&#xff0c;到现在学习对我而言就如同一日三餐&#xff1…
阅读更多...
Three.js——基于原生WebGL封装运行的三维引擎

Three.js——基于原生WebGL封装运行的三维引擎

文章目录 前言一、什么是WebGL&#xff1f;二、Three.js 特性 前言 Three.js中文官网 Three.js是基于原生WebGL封装运行的三维引擎&#xff0c;在所有WebGL引擎中&#xff0c;Three.js是国内文资料最多、使用最广泛的三维引擎。既然Threejs是一款WebGL三维引擎&#xff0c;那么…
阅读更多...
【操作系统】考研真题攻克与重点知识点剖析 - 第 3 篇：内存管理

【操作系统】考研真题攻克与重点知识点剖析 - 第 3 篇：内存管理

前言 本文基础知识部分来自于b站&#xff1a;分享笔记的好人儿的思维导图与王道考研课程&#xff0c;感谢大佬的开源精神&#xff0c;习题来自老师划的重点以及考研真题。此前我尝试了完全使用Python或是结合大语言模型对考研真题进行数据清洗与可视化分析&#xff0c;本人技术…
阅读更多...
JPA Buddy快速创建update、find、count、delete、exists方法

JPA Buddy快速创建update、find、count、delete、exists方法

JPA Buddy快速创建update、find、count、delete、exists方法&#xff0c;JPA默认提供的CrudRepository\JpaRepository提供的方法比较少&#xff0c;一般我们会手写一些方法&#xff0c;这里我们选择通过JPA Buddy快速生成&#xff0c;之前文章中讲到了JPA Buddy原本是IDEA收费插…
阅读更多...
Spark Job优化

Spark Job优化

1 Map端优化 1.1 Map端聚合 map-side预聚合&#xff0c;就是在每个节点本地对相同的key进行一次聚合操作&#xff0c;类似于MapReduce中的本地combiner。map-side预聚合之后&#xff0c;每个节点本地就只会有一条相同的key&#xff0c;因为多条相同的key都被聚合起来了。其他节…
阅读更多...
前端面试题 计算机网络

前端面试题 计算机网络

文章目录 ios 7层协议tcp协议和udp协议的区别tcp协议如何确保数据的可靠http和tcp的关系url输入地址到呈现网页有哪些步骤post和get本质区别&#xff0c;什么时候会触发二次预检GET请求&#xff1a;POST请求&#xff1a;触发二次预检&#xff08;CORS中的预检请求&#xff09;&…
阅读更多...
SolidWorks绘制花瓶教程

SolidWorks绘制花瓶教程

这个花瓶是我学习solidworks画图以来用时最长的一个图形了&#xff0c;特此记录一下&#xff0c;用了我足足两个早晨才把他给画出来&#xff0c;我这是跟着哔站里的隔壁老王学习的&#xff0c;下面是视频地址&#xff1a;点击我一下看视频教程 下面是我的绘图过程&#xff0c;…
阅读更多...
美国材料与试验协会ASTM发布新版玩具安全标准 ASTM F963-23

美国材料与试验协会ASTM发布新版玩具安全标准 ASTM F963-23

美国材料与试验协会ASTM发布新版玩具安全标准 ASTM F963-23 2023年10月13日&#xff0c;美国材料与试验协会&#xff08;ASTM&#xff09;发布了新版玩具安全标准ASTM F963-23 ​根据CPSIA的规定&#xff0c;当ASTM将ASTM F963的拟定修订意见通知CPSC时&#xff0c;若CPSC认为…
阅读更多...
如何配置Apple推送证书 push证书

如何配置Apple推送证书 push证书

转载&#xff1a;如何配置Apple推送证书 push证书 想要制作push证书&#xff0c;就需要使用快捷工具appuploader工具制 作证书&#xff0c;然后使用Apple的推送功能配置push证书&#xff0c;就可以得到了。PS&#xff1a;push没有描述文件&#xff0c;所以不 要问推送选择哪…
阅读更多...
【c++随笔12】继承

【c++随笔12】继承

【c随笔12】继承 一、继承1、继承的概念2、3种继承方式3、父类和子类对象赋值转换4、继承中的作用域——隐藏5、继承与友元6、继承与静态成员 二、继承和子类默认成员函数1、子类构造函数 二、子类拷贝构造函数3、子类的赋值重载4、子类析构函数 三、单继承、多继承、菱形继承1…
阅读更多...
视觉大模型DINOv2:自我监督学习的新领域

视觉大模型DINOv2:自我监督学习的新领域

1 DINOv2 1.1 DINOv2特点 前段时间&#xff0c;Meta AI 高调发布了 Segment Anything&#xff08;SAM&#xff09;&#xff0c;SAM 以交互式方式快速生成 Mask&#xff0c;并可以对从未训练过的图片进行精准分割&#xff0c;可以根据文字提示或使用者点击进而圈出图像中的特定…
阅读更多...
Flink SQL 表值聚合函数（Table Aggregate Function）详解

Flink SQL 表值聚合函数（Table Aggregate Function）详解

使用场景&#xff1a; 表值聚合函数即 UDTAF&#xff0c;这个函数⽬前只能在 Table API 中使⽤&#xff0c;不能在 SQL API 中使⽤。 函数功能&#xff1a; 在 SQL 表达式中&#xff0c;如果想对数据先分组再进⾏聚合取值&#xff1a; select max(xxx) from source_table gr…
阅读更多...
第24章_mysql性能分析工具的使用

第24章_mysql性能分析工具的使用

文章目录 1. 数据库服务器的优化步骤2.查看系统性能参数3. 统计SQL的查询成本&#xff1a;last_query_cost4. 定位执行慢的 SQL&#xff1a;慢查询日志4.1 开启慢查询日志参数4.2 查看慢查询数目4.3 测试慢sql语句&#xff0c;查看慢日志4.4 系统变量 log_output&#xff0c; l…
阅读更多...
用excel计算一个矩阵的转置矩阵

用excel计算一个矩阵的转置矩阵

假设我们的原矩阵是一个3*3的矩阵&#xff1a; 125346789 现在求它的转置矩阵&#xff1a; 鼠标点到一个空白的地方&#xff0c;用来存放结果&#xff1a; 插入-》函数&#xff1a; 选择TRANSPOSE&#xff0c;这个就是求转置矩阵的函数&#xff1a; 点击“继续”&#xff1a…
阅读更多...
Windows查看端口占用情况

Windows查看端口占用情况

Windows如何查看端口占用情况 方法1. cmd命令行执行netstat命令&#xff0c;查看端口占用情况 netstat -ano 以上命令输出太多信息&#xff0c;不方便查看&#xff0c;通过如下命令搜索具体端口占用情况&#xff0c;例如&#xff1a;8080端口 netstat -ano | findstr "…
阅读更多...
初阶JavaEE（17）Linux 基本使用和 web 程序部署

初阶JavaEE（17）Linux 基本使用和 web 程序部署

接上次博客&#xff1a;初阶JavaEE&#xff08;16&#xff09;博客系统&#xff08;Markdown编辑器介绍、博客系统功能、博客系统编写&#xff1a;博客列表页 、博客详情页、实现登录、实现强制登录、显示用户信息、退出登录、发布博客&#xff09;-CSDN博客 目录 Linux 基本…
阅读更多...
std::any

std::any

一、简介 std::any 可以储存任何可拷贝构造和可销毁的类型的对象。 struct test {test(int a,int b){} };int main(int argc, char *argv[]) {std::any a 1;qDebug() << a.type().name();a 3.14;qDebug() << a.type().name();a true;qDebug() << a.type…
阅读更多...
从0到0.01入门React | 010.精选 React 面试题

从0到0.01入门React | 010.精选 React 面试题

🤍 前端开发工程师（主业）、技术博主（副业）、已过CET6 🍨 阿珊和她的猫_CSDN个人主页 🕠 牛客高级专题作者、在牛客打造高质量专栏《前端面试必备》 🍚 蓝桥云课签约作者、已在蓝桥云课上架的前后端实战课程《Vue.js 和 Egg.js 开发企业级健康管理项目》、《带你从入…
阅读更多...
开发者测试2023省赛--UnrolledLinkedList测试用例

开发者测试2023省赛--UnrolledLinkedList测试用例

测试结果 官方提交结果 EclEmma PITest 被测文件UnrolledLinkedList.java /** This source code is placed in the public domain. This means you can use it* without any restrictions.*/package net.mooctest;import java.util.AbstractList; import java.util.Collectio…
阅读更多...
Postman模拟上传文件

Postman模拟上传文件

如图&#xff0c;在F12抓到的上传文件的请求 那要在postman上模拟这种上传&#xff0c;怎么操作呢&#xff0c;如图&#xff0c;选中【Select File】选取文件上传即可
阅读更多...
最新文章
推荐文章

Copyright @ 2022~2023