【知识整理】Git Commit Message 规范_commit message rule violation

最新推荐文章于 2024-05-09 14:05:08 发布
最新推荐文章于 2024-05-09 14:05:08 发布
阅读量914 收藏 13
点赞数 25
分类专栏： 2024年程序员学习 文章标签： git
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2401_84181383/article/details/137502506
版权
本文详细介绍了Git Commit Message的规范，包括标题行、主体内容和尾部的编写要求，旨在提供清晰、一致的提交信息。内容涵盖类型、影响范围、变更原因、解决方案和可能的副作用。还提及了Vscode的集成以及commitizen插件的使用。
摘要由CSDN通过智能技术生成
# CH <类型>[可选的作用域]: <描述> // 空一行 [可选的正文] // 空一行 [可选的脚注]

Commit Message 提示说明

标题行 类型（影响范围）：50个字符以内，描述主要变更内容

空一行

主体内容：更详细的说明文本，建议72个字符以内。 需要描述的信息包括:

* 为什么这个变更是必须的? 它可能是用来修复一个bug，增加一个feature，提升性能、可靠性、稳定性等等

* 他如何解决这个问题? 具体描述解决问题的步骤

* 是否存在副作用、是否会有风险?

空一行

尾部：是需要的化可以添加一个链接到issue地址或者其它文档，或者是关闭了某个issue。

示例

// 示例1
fix(global):修复checkbox不能复选的问题
// 示例2 圆括号里的 common 为通用管理的名称
fix(common): 修复字体过小的BUG，将通用管理下所有页面的默认字体大小修改为 14px

1、格式拆解 Header

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

Header 里 type 部分

最低0.47元/天 解锁文章
2401_84181383
关注
专栏目录
ubuntu交叉编译onnxruntime源码_cpu版本
cumtchw
12-09 3279
ubuntu交叉编译(armv7_32位)onnx源码_cpu版本
Git Commit message 规范
Wiliam的博客
02-07 5111
Git Commit message 规范介绍格式HeaderBodyFooterRevert常用示例featfixdocsstylerefactorperftestchorerevert参考链接 介绍 在 Git 中，每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。这个操作将通过 git commit 完成。 git commit -m "芜湖~起飞" 上面代码的-m参数，就是用来指定 commit message 的。 如果一行不够，可以只执行 git commit
【Git】Git commit message的自我修养（规范化）
徐海东的博客
10-28 1280
Git commit 的介绍 从git官网我们可以知道Git commit作用是记录对仓库的修改 在日常开发中，使用Git命令最多的应该就是Git commit ，然而书写规范的commit message能够提高开发人员的代码维护升级效率，在能快速方便排查问题。那么commit message的规范就十分重要了 Git commit message的规范 目前使用比较多的规范是Ang...
Git Commit Message规范
qq_25775675的博客
10-13 2163
Git commit message规范是一种良好的实践，可以帮助开发团队更好地理解和维护代码库的历史记录。它可以提高代码质量、可读性和可维护性。
【知识整理】Git Commit Message 规范_git commit msg 规则
2401_84183492的博客
04-12 1825
外链图片转存中…(img-VKZ2Dmto-1712871950994)]
Git Commit 之道：规范化 Commit Message 写作指南
热门推荐
pursuit的博客
11-12 1万+
在软件开发的征程中，清晰明了的 Git Commit Messages 是项目成功的关键。本指南将教你如何通过规范化 Git 提交信息，提高代码可读性，以及如何巧妙撰写自动生成的 Change Logs，精准记录项目的演变。让你的团队与你共同领略 Git Commit 的精髓，推动项目可维护性的巅峰。
【x64dbg】snapshot_2022-02-25_22-14
02-28
1. **commithash.txt** - 这个文件通常包含的是软件源代码管理系统的提交哈希，比如Git。它是一个唯一的标识符，对应于特定的代码更改。通过这个哈希，开发者可以追溯到x64dbg在那个时间点的源代码状态，查看具体的...
Git公钥生成及后续问题解决
三月，有人呼唤你的名字
08-05 4574
因为博主使用的Ubuntu昨天莫名其妙出现故障，终端消失在搜索无果后，选择重启Ubuntu,结果ubuntu彻底崩了，只出现桌面背景，没有图标，在进入控制台设置多次无果后，博主选择重新安装ubuntu.在更改完中文环境，安装好中文输入法后，最大的问题来了，要进行配置我的git仓库coding.net，在一开始git init ,git push -u origin master,git add hello.c,git commit -m “注释”以后，git push提示我：Permission deni
Git commit message规范
lingyang999的博客
08-16 6263
参考文档：https://mp.weixin.qq.com/s/mAUqTPCqcYjoNDqAxktyfA 使用工具简介：commitizen、cz-conventional-changelog、commitlint、husky commitizen：Commitizen是一款提升GIT提交过程效率的小工具。它会提示你提供任何必要字段，还会恰当地格式化提交信息。Commitizen内置了对多种提交规范的支持，同时还允许你定制自己的提交规则。这个简单的工具能够节约时间，而不必等待提交钩子运行检查再驳回提
【知识整理】Git Commit Message 规范
李木
02-23 2630
前面咱们整理过Code Review 一文，提到了 Review 的重要性，已经同过gitlab进行CodeReview 的方式，那么本文详细说明一下对CodeReivew非常重要的Git Commit Message 规范。我们在每次提交代码时，都需要编写 Commit Message，否则是不允许提交的。书写好的 Commit Message 能大大提高代码维护的效率。避免开发人员在项目中群魔乱舞，搞得代码一团糟，搞的项目就被糟践了。且开发日后的维护，都将是灾难。
Git如何规范填写Commit Message
阿璐4r的博客
06-20 1362
0.规范commit message的好处 可以清晰地知道每个 commit 的变更内容 可以基于这些 Commit Message 进行过滤查找，比如只查找某个版本新增的功能：git log --oneline --grep “^feat | ^fix| ^perf" 可以基于规范化的 Commit Message 生成 Change Log。 可以依据某些类型的 Commit Message 触发构建或者发布流程，比如当 type 类型为 feat、fix 时我们才触发 CI 流程。 确定语义化版本的
2024年【知识整理】Git Commit Message 规范_git commit msg 规则，2024年最新跪了
最新发布
2401_84181368的博客
05-09 321
refactordocsstyletestchorebuildperfcirevertscope 也为选填项，用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同，格式为项目名/模块名。如果你的修改影响了不止一个 scope，你可以使用*代替。例如：global、common、http、* 、数据库等等，记得加上括号subject是 commit 目的的简短描述，不超过50个字符。
Git —— Commit Message 规范介绍
Ccccxc的博客
12-26 2592
日常开发中，我们经常会使用到 Git 进行代码管理，而 Git 中最常用的命令就是git commit，我们通过 commit 命令将修改后的代码提交到本地仓库，然后再通过git push命令将本地仓库的代码推送到远程仓库。git 规定提交时必须要写提交信息，作为改动说明，保存在 commit 历史中，方便回溯。规范的 log 不仅有助于他人 review, 还可以有效的输出 CHANGELOG，甚至对于项目的研发质量都有很大的提升，尤其是一些长期持续迭代维护，且多版本长期并存的项目。
Git commit message 规范
weixin_34347651的博客
06-20 1186
git是现在市面上最流行的版本控制工具，书写良好的commit message能大大提高代码维护的效率。但是在日常开发中由于缺少对于commit message的约束，导致填写内容随意、质量参差不齐，可读性低亦难以维护。在项目中引入commit message规范已是迫在眉睫。 用什么规范？ 现在市面上比较流行的方案是约定式提交规范（Conventional Commits），它受到了Ang...
git commit message 规范
06-06
Git commit message规范是指Git版本控制系统中提交代码时，对于commit message的书写规范化。这样可以让每个commit message都更加清晰明确，便于开发者和其他项目成员理解和维护代码。常见的规范包括commit message...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值