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.mzph.cn/news/140840.shtml

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

相关文章

Asp.Net Core 中使用配置文件

Asp.Net Core 中使用配置文件

本文参考微软文档&#xff1a;ASP.NET Core 中的配置 ASP.NET Core 中的应用程序配置是使用一个或多个配置程序提供程序执行的。 配置提供程序使用各种配置源从键值对读取配置数据&#xff1a; 设置文件&#xff0c;例如 appsettings.json环境变量Azure Key VaultAzure 应用配…
阅读更多...
Oracle导入，注意事项

Oracle导入，注意事项

在执行导入时&#xff0c;如果导入的触发器引用的表不存在&#xff0c;可能会导致错误。触发器通常会在相关的表结构之后导入&#xff0c;但在导入阶段&#xff0c;表的创建并不一定会立即执行。 在 Oracle 数据库中&#xff0c;触发器的创建可能涉及到对表的引用&#xff0c;…
阅读更多...
NLP在网安领域中的应用（初级）

NLP在网安领域中的应用（初级）

NLP在网安领域的应用 写在最前面1. 威胁情报分析1.1 社交媒体情报分析&#xff08;后面有详细叙述&#xff09;1.2 暗网监测与威胁漏洞挖掘 2. 恶意软件检测2.1 威胁预测与趋势分析 3. 漏洞管理和响应4. 社交工程攻击识别4.1 情感分析与实时监测4.2 实体识别与攻击者画像构建4.…
阅读更多...
金蝶云星空设置单据体行高

金蝶云星空设置单据体行高

文章目录 金蝶云星空设置单据体行高表单插件Python脚本 金蝶云星空设置单据体行高 表单插件 新建类继承AbstractBillPlugIn&#xff0c;重写OnInitialize方法进行设置 public override void OnInitialize(InitializeEventArgs e){base.OnInitialize(e);this.View.GetControl&…
阅读更多...
Qt绘制各种图形

Qt绘制各种图形

重载绘图事件&#xff1a; protected:void paintEvent(QPaintEvent *event) Q_DECL_OVERRIDE;void Widget::paintEvent(QPaintEvent *event) { 进行绘图操作 } 绘图前操作&#xff1a; //基本绘图QPainter painter(this);//创建QPainter对象painter.setRenderHint(QPa…
阅读更多...
nav2 调节纯追踪算法

nav2 调节纯追踪算法

纯追踪算法 纯追踪基础 The core idea is to find a point on the path in front of the robot and find the linear and angular velocity to help drive towards it. 核心思想是在机器人前方的路径上找到一个点&#xff0c;并找到一个合适的线速度和角速度&#xff0c;以驱…
阅读更多...
MFC 简单绘图与文本编辑

MFC 简单绘图与文本编辑

目录 一.创建单文档项目 二.消息映射机制 三.WM_PAINT消息触发 四.CVIEW类 五.设备上下文 六.资源类和资源的关系 七.画线&#xff0c;矩形 八.画布 九.画笔 十.画刷 十一.利用TRACE打印日志 十二.文本编程 十三.ID号 十四.菜单栏 十五.菜单命令路由 十六.工具…
阅读更多...
如何快速入门笔记软件『Obsidian』

如何快速入门笔记软件『Obsidian』

前言 Obsidian 是基于 Markdown 语法的笔记软件&#xff0c;界面简洁&#xff0c;使用简单&#xff0c;功能实用&#xff0c;支持跨平台数据同步&#xff0c;实现基于双向链接的知识图谱&#xff0c;同时提供各种各样的扩展主题和插件 本文将会详细讲解笔记软件 Obsidian 的安…
阅读更多...
如何设置静态代理IP切换电脑上网地址使用？

如何设置静态代理IP切换电脑上网地址使用？

在当今的网络时代&#xff0c;代理IP已成为一种常见的网络访问方式。通过使用代理IP&#xff0c;我们可以隐藏自己的真实IP地址&#xff0c;从而保护自己的隐私和安全。但是&#xff0c;有时候我们需要切换代理IP来满足不同的上网需求。本文将介绍如何设置静态代理IP切换电脑上…
阅读更多...
实现一个简单的瀑布流列表

实现一个简单的瀑布流列表

实现一个两列的瀑布流布局&#xff0c;支持无限滚动 **思路&#xff1a;**利用flex布局&#xff0c;将列表分为左右两侧&#xff0c;因为这种方式存在一个弊端&#xff0c;就是当有一侧的高度越来越高的时候&#xff0c;滑到底部的时候就会出现一个很明显的高度差&#xff0c;为…
阅读更多...
odoo16前端框架源码阅读——rpc_service.js

odoo16前端框架源码阅读——rpc_service.js

odoo16前端框架源码阅读——rpc_service.js 先介绍点背景知识&#xff0c;这样方便阅读代码。 一、 JSONRPC的规范 https://www.jsonrpc.org/specification 中文翻译版本&#xff1a;https://wiki.geekdream.com/Specification/json-rpc_2.0.html JSON-RPC是一个无状态且轻…
阅读更多...
使用swagger-typescript-api

使用swagger-typescript-api

引言 前后端分离大致是这样的 后端&#xff1a;控制层 / 业务层 / 数据操作层前端&#xff1a;控制层 / 视图层 前后端的控制层&#xff0c;实际上就是前后端接口的对接 前后端分离&#xff0c;实现了更好地解耦合&#xff0c;但也引入了接口对接的过程&#xff0c;这个过程…
阅读更多...
ChatGPT-3.5 插件推荐：语音输入，视频总结，联网检索

ChatGPT-3.5 插件推荐：语音输入，视频总结，联网检索

前言 GPT4 里是有内置的插件市场的&#xff0c;不过博主一直觉得自己对这个工具的使用还不够到位&#xff0c;现在购买升级版性价比不划算所以暂时还没有开。不过今天在学习使用的时候&#xff0c;发现 GPT3.5 也是可以通过网页插件方式进行升级扩展的&#xff0c;而且功能还比…
阅读更多...
ChatGPT+Roblox，元宇宙的AI叙事逻辑#Leveling Up

ChatGPT+Roblox，元宇宙的AI叙事逻辑#Leveling Up

MixCopilot 嗨&#xff0c;亲爱的听众朋友们&#xff01;欢迎收听我们的播客节目&#xff01;我是你们的主播&#xff1a;MixCopilot 混合副驾。今天我们要为大家带来的是我们的AI革命系列节目之一。这个系列节目聚焦于AI领域的一些最有影响力的建设者&#xff0c;他们将会讨论…
阅读更多...
web网站 固定的邀请码字符 能被爬虫爬取吗？动态改变邀请码的字符是不是可以避免爬虫爬取或数据泄露

web网站 固定的邀请码字符 能被爬虫爬取吗？动态改变邀请码的字符是不是可以避免爬虫爬取或数据泄露

无论邀请码字符是固定的还是动态改变的&#xff0c;都无法完全避免爬虫爬取或数据泄露的风险。以下是一些要考虑的因素&#xff1a; 爬虫技术的发展&#xff1a;爬虫技术不断发展&#xff0c;可以智能地解析和获取网页内容。即使邀请码字符是固定的&#xff0c;高级爬虫仍然可以…
阅读更多...
Linux - 驱动开发 - watchdog - SMP机制下多核确活

Linux - 驱动开发 - watchdog - SMP机制下多核确活

说明 理论上&#xff1a;不管IC是单核还是多核&#xff0c;只要watchdog有被循环feed&#xff0c;就不会触发超时重启&#xff0c;因此watchdog在SMP机制下的多核环境显得比较宽松&#xff0c;只要任意核存活&#xff08;喂狗&#xff09;就不会重启设备。 实际情况 有客户反…
阅读更多...
直播间自动发言机器人的运行分享，与开发需要到的技术分析

直播间自动发言机器人的运行分享，与开发需要到的技术分析

先来看实操成果&#xff0c;↑↑需要的同学可看我名字↖↖↖↖↖&#xff0c;或评论888无偿分享 一、引言 随着人工智能技术的不断发展&#xff0c;自动发言机器人已经成为了当今社交媒体领域的重要组成部分。它们能够自动化地发布内容、回复用户评论和消息&#xff0c;大大提高…
阅读更多...
【数据结构】栈和队列的模拟实现（两个方式实现）

【数据结构】栈和队列的模拟实现（两个方式实现）

前言 &#x1f493;作者简介&#xff1a; 加油&#xff0c;旭杏&#xff0c;目前大二&#xff0c;正在学习C&#xff0c;数据结构等&#x1f440; &#x1f493;作者主页&#xff1a;加油&#xff0c;旭杏的主页&#x1f440; ⏩本文收录在&#xff1a;再识C进阶的专栏&#x1…
阅读更多...
Qt绘制简单图表

Qt绘制简单图表

Qt图表类似于model/view&#xff0c;chart就是model。 创建图表的各个部件&#xff1a; QChart *chart new QChart();chart->setTitle(tr("简单函数曲线")); // chart->setAcceptHoverEvents(true);ui->chartView->setChart(chart);ui->chartVi…
阅读更多...
网络安全自学

网络安全自学

前言 一、什么是网络安全 网络安全可以基于攻击和防御视角来分类&#xff0c;我们经常听到的 “红队”、“渗透测试” 等就是研究攻击技术&#xff0c;而“蓝队”、“安全运营”、“安全运维”则研究防御技术。 无论网络、Web、移动、桌面、云等哪个领域&#xff0c;都有攻与防…
阅读更多...
最新文章

Copyright @ 2022~2023