Git Commit message 规范

最新推荐文章于 2024-05-09 14:05:08 发布
最新推荐文章于 2024-05-09 14:05:08 发布
阅读量5k 收藏 21
点赞数 1
分类专栏： git规范 文章标签： git 前端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/wiaaiam/article/details/122806282
版权

Git Commit message 规范

介绍

在 Git 中，每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。这个操作将通过 git commit 完成。

git commit -m "芜湖~起飞"

上面代码的-m参数，就是用来指定 commit message 的。

如果一行不够，可以只执行 git commit ，就会跳出文本编译器，让你写多行。

git commit

但是很显然的问题像 芜湖~起飞 这样没有规范的commit message，我们并没有办法去快速的了解此次提交的目的究竟是什么。所以，我们需要学习了解并落实commit message规范。

格式

Commit message 包括三个部分：Header，Body 和 Footer。可以用下方的格式表示它的结构。

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

其中，Header 是必需的，Body 和 Footer 可以省略(默认忽略)，一般我们在 git commit 提交时指定的 -m 参数，就相当于默认指定 Header。

不管是哪一个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免自动换行影响美观。

Header

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

  • type
    用于说明 commit 的类别，只允许使用下面8个标识。
  • feat：新功能（feature）
  • fix：修补bug
  • docs：文档（documentation） 比如README, CHANGELOG, CONTRIBUTE等
  • style：代码格式化（仅仅修改了空格、格式缩进、逗号等，不改变代码逻辑）
  • refactor：重构（即不是新增功能，也不是修改bug的代码变动）
  • perf: 优化相关，比如提升性能、体验
  • test：测试用例，包括单元测试、集成测试等
  • chore：改变构建过程或增加依赖库、辅助工具等
  • revert: 回滚代码
  • scope
    用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视仓库不同而不同。
    也可以作为相关模块或组件的类型、名称。例如：

fix(css): 修改 起飞按钮 样式
chore(deps): 更新 moment 至 2.24.0 版本
chore(build): 修改生产环境命令配置

  • subject
    是 commit 目的的简短描述，不超过50个字符。
  • 以动词开头，使用第一人称现在时，比如"新增"、“修复”、“更改”、“优化”
  • 第一个字母小写
  • 结尾不加句号（.）

Body

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

More detailed explanatory text, if necessary.  Wrap it to 
about 72 characters or so. 

Further paragraphs come after blank lines.

- Bullet points are okay, too
- Use a hanging indent

有两个注意点。

  • 使用第一人称现在时，比如使用"新增"、“修复”、“更改”、“优化”。
  • 应该说明代码变动的动机，以及与以前行为的对比。

Footer

Footer 部分只用于两种情况。

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

  • 关闭 Issue 或者 bug
    如果当前 commit 针对某个 issue 或者 bug ，那么可以在 Footer 部分关闭。

Closes #234

也可以一次关闭多个。

Closes #123, #245, #992

Revert

还有一种特殊情况，如果当前 commit 用于撤销以前的 commit，则必须以revert:开头，后面跟着被撤销 Commit 的 Header。

revert: feat: 新增了起飞组件
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.

Body部分的格式是固定的，必须写成This reverts commit <hash>，其中的hash是被撤销 commit 的 SHA 标识符。

常用示例

feat

feat: 新增了起飞组件

fix

fix: 修复 起飞按钮失效的问题 (#12345)
fix: 修复 起飞按钮失效，导航栏显示异常的问题（#12345,#12346）

docs

docs: 更新 README文档

style

style: 删除 起飞组件多余空格

refactor

refactor: 重构 起飞组件

perf

perf: 优化 起飞页面性能

test

test: 新增 起飞组件 测试用例

chore

chore(deps): 更新 moment 至 2.24.0 版本
chore(build): 修改生产环境命令配置

revert

revert: feat: 新增了起飞组件
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.

参考链接

William Ma
关注
  • 1
    点赞
  • 踩
  • 21
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
git commit 规范
qq_32320925的博客
12-01 1084
git commit 规范
git commit回滚——两种方式
热门推荐
HD243608836的博客
07-07 5万+
1. 应用场景 ： 撤销已经提交的commit 2. 解决方案： 使用 git reset --hard HEAD^ 使用 git rebase -i HEAD~n 下面分别介绍下这两个方案有什么不同，和他们的使用场景 。 2.1 git reset --hard 丢弃最新的提交 代码提交后，需求发生变化导致之前提交的已经不合适，或者 代码提交后发现有严重bug，需要回滚可是使用这个命令： git reset --hard HEAD^ tips: 1，HEAD^ .
2024年【知识整理】Git Commit Message 规范_git commit msg 规则，2024年最新跪了
最新发布
2401_84181368的博客
05-09 259
refactordocsstyletestchorebuildperfcirevertscope 也为选填项，用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同，格式为项目名/模块名。如果你的修改影响了不止一个 scope，你可以使用*代替。例如：global、common、http、* 、数据库等等，记得加上括号subject是 commit 目的的简短描述，不超过50个字符。
【知识整理】Git Commit Message 规范_commit message rule violation
2401_84181383的博客
04-08 887
伙伴深入学习提升的进阶课程，基本涵盖了95%以上大数据开发知识点，真正体系化！**
【Git】commit提交代码
春天的波菜
06-30 6901
接 katalon配置git与git项目创建_春天的菠菜的博客-CSDN博客it提交代码的正确步骤命令?在程序员们进行代码开发时，常常会使用到git这款代码管理工具，但是不少新手在学习git时不知道git提交代码的正确步骤，导致常常代码提交失败，那么今天小编就来告诉大家git提交代码的正确步骤命令，帮助大家正确的提交代码。git提交代码的正确步骤命令1、提交代码第一步：git status查看当前状态。当你忘记修改了哪些文件的时候可以使用git status来查看当前状态，红色的字体显示的就是你修改的文件;
Git命令 git commit -am
weixin_45179978的博客
12-18 1329
git commit -m与git commit -am的区别理论实例总结 使用git commit -am是不是就可以完全不使用git add命令呢？不是 理论 要了解git commit -m与git commit -am的区别，首先要明白它们的定义 字面解释的话，git commit -m用于提交暂存区的文件，git commit -am用于提交跟踪过的文件 [注意]git commit -am可以写成git commit -a -m，但不能写成git commit -m -a 定义中出现了暂存区、跟
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 模板插件
How to Write a Git Commit Message
04-25
一篇非常不错的关于提交GIT message的英文文章
vscode-git-commit
04-10
VSCode git commit是一个VSCode扩展，用于创建带有表情符号和前缀的精美提交消息。 那是第一个版本：P 如何使用它 ？ 使用ctrl+alt+enter （在Mac上为cmd+shift+enter ）或click SouceControl中的图标 设定值 1....
GitEmoji- emoji for git commit message-crx插件
04-02
语言:English (United States) 表情符号的git commit消息 提交消息的表情符号指南。 它只是https://gitmoji.carloscuesta.me/的Chrome扩展版本
git的add、commit、push的详细介绍
qinjie的博客
09-27 7951
1、git status 查看工作区代码相对于暂存区的差别 2、git add . 将当前目录下修改的所有代码从工作区添加到暂存区 . 代表当前目录 3、git commit -m ‘注释’ 将缓存区内容添加到本地仓库 4、git pull origin master先将远程仓库master中的信息同步到本地仓库master中 6、git push origin master 将本地版本库推送到远程服务器， 7、origin是远程主机，master表示是远程服务器上的master分支和本地分支重名的简写，分
Git commit -m与-am
思维小刀
04-07 1261
参考https://www.cnblogs.com/smile-fanyin/p/10827438.html 结论 这两个命令的区别的关键就是git add命令 git add命令是个多功能命令，根据目标文件的状态不同，此命令的效果也不同：可以用它开始跟踪新文件，或 者把已跟踪的文件放到暂存区，还能用于合并时把有冲突的文件标记为已解决状态等 我们需要用git add命令来跟踪新文件，但如果使...
Git Commit Message 编写指南
qq_45949848的博客
10-21 227
Git 每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。上面代码的-m参数，就是用来指定 commit mesage 的。但是，一般来说，commit message 应该清晰明了，说明本次提交的目的。目前，社区有多种 Commit message 的。本文介绍（见上图），这是目前使用最广的写法，比较合理和系统化，并且有配套的工具。
Git Commit Message 规范
steveliu->blog
10-19 516
Git commit message规范
关于git代码上传的规范以及commit message 模板的自动生成
android 系统定制开发那些事
11-11 4947
关于git代码上传的规范以及commit message 模板的自动生成
Git Commit Message提交规范
weixin_32304201的博客
05-06 975
Git Commit Message提交规范1. 简述2. 格式介绍3. 各部分部分介绍4. git commit message格式举例 1. 简述 关于 Git message 的写法规范社区中有很多种， 目前使用较为广泛的是 Angular 规范。 在 Angular 规范中， 每次提交， Commit message 都包括三个部分： Header、Body 和 Footer，下面进行详细介绍。 2. 格式介绍 <type>(<scope>):<subject>
Git Commit Message 格式规范
linyiheng123的专栏
05-31 822
(): // 空一行// 空一行
Git学习总结（23）——Git commit message和版本管理规范总结
科技D人生
10-19 2366
一、Git commit message基本规范 对格式的说明如下： type代表某次提交的类型，比如是修复一个bug还是增加一个新的feature。所有的type类型如下： feat： 新增feature fix: 修复bug docs: 仅仅修改了文档，比如README, CHANGELOG, CONTRIBUTE等等 style: 仅仅修改了空格、格式缩进、都好等等，不改变代码逻...
git commit message 规范
06-06
### 回答1： Git commit message规范是指Git版本控制系统中提交代码时，对于commit message的书写规范化。这样可以让每个commit message都更加清晰明确，便于开发者和其他项目成员理解和维护代码。常见的规范包括commit message的格式、内容、长度、语言等方面。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值