git commit 提交规范

最新推荐文章于 2024-10-13 15:43:49 发布
最新推荐文章于 2024-10-13 15:43:49 发布
阅读量534 收藏
点赞数 1
文章标签： git
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Nicolas_shen/article/details/124498434
版权

git的提交使用git commit -m "hello world"来提交comment,但是一些像hello world这样没有意义的comment让人无法理解这次的提交到底是为了什么
下面是一些基础介绍如果觉得麻烦直接查看第二部分

1. commit message format(信息域)

commit message一般分为三个部分Header，Body 和 Footer


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

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

Example:
PS D:\git\pythonPractice> git log
commit 58a7a966acb9aa2fffc0e02c9ce3be64b8949991 (HEAD -> master)
Author: Zhiwei Tian <hebeitianzhiwei@outlook.com>
Date:   Fri Aug 17 17:38:36 2018 +0800

    feat(serve): add grpc server
1.1 HEAD
  • type用于说明 commit 的类别，只允许使用下面7个标识
feat：新功能（feature）
fix：修补bug
docs：文档（documentation）
style： 格式（不影响代码运行的变动）
refactor：重构（即不是新增功能，也不是修改bug的代码变动）
test：增加测试
chore：构建过程或辅助工具的变动
revert: 回滚到上一个版本
  • 非必填（建议填写）， 用于说明 commit 影响的范围，建议填写影响的功能模块。如果修改影响不止一个 scope，可以使用 * 代替
  • subject comment所在的位置,这次提交的简短描述，必填，commit 目的的简短描述，不超过50个字符，以动词开头，使用第一人称现在时，比如 change，而不是changed或changes， 第一个字母小写，结尾不加句号

2 Body

是对本次 commit 的详细描述，可以分成多行
非必填（建议填写），可描述当前修改的行为详细信息或修改的目的

1.3 Footer

部分只用于两种情况

  • 不兼容变动

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

  • 关闭 Issue
    如果当前 commit 针对某个issue，那么可以在 Footer 部分关闭这个 issue (可依次关闭过个issueCloses #123, #245, #992)

1.4 Revert

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

revert: type(scope):  some comment
This reverts commit bfe307ce57d87677c6c473c228e6c2ed8b81dcec.

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

如果当前 commit 与被撤销的 commit，在同一个发布（release）里面，那么它们都不会出现在 Change log 里面。如果两者在不同的发布，那么当前 commit，会出现在 Change log 的Reverts小标题下面

引用：git commit 提交规范

程程阅的程程悦
关注
Git Commit提交规范总结
拾年一剑 的专栏
02-27 6414
团队协作中，规范的Git提交记录，使提交历史明确可追溯，有助于更好的协作，方便后期代码的开发和维护
Git Commit提交规范和IDEA插件Git Commit Template的使用
热门推荐
noaman_wgs的博客
12-06 1万+
Git是最牛逼的开源分布式版本控制系统，日常开发中常用来管理代码提交、恢复、追踪，是团队开发最常用的一个代码管理工具。 在我们修改了代码并且提交之前，常会使用git commit -m 'change'命令来描述我们代码改动的内容，但是很多都不规范，随处可见的 git commit -m 'update'，以致于不能清晰地知道每次提交代码的变更内容，所以需要一种规范来管理代码提交的内容。 一、Gi...
Git—commit规范
m0_73555097的博客
09-02 780
使用git多人开发时，如果不使用统一的规范则会导致每次更新的内容描述千差万别，不利于多人协作，所以尽量规范commit写法，使内容提交清晰明了。
Git Commit 提交规范
江江的博客
07-05 288
Conventional Commits 规范是一种轻量级的提交信息约定。它提供了一套简单的规则，用于创建明确的提交历史，从而更容易在此基础上编写自动化工具。该规范与 SemVer（语义化版本）相辅相成，通过在提交信息中描述特性、修复和重大变更，明确版本变更的类型。
统一git使用方法，git状态变迁图，git commit提交规范
vczxh的专栏
08-21 574
要在本地合并代码再提交到远程；自行查资料学习git并使用，会出现使用各种偏僻的命令，异常问题无法解决；参考 https://blog.csdn.net/zhgeliang/article/details/81110179。git设置 mergetool为kdiff3//解决冲突使用kdiff3软件。git commit --amend -m "实际修改注释"提交本地master分支到远程master分支。把远程下载的代码合并到远程master分支。对比本地修改与git节点的差别。修改git文件和节点描述。
如何查看git 中的git commit 提交规范
07-28
回答: 要查看git中的git commit提交规范，可以执行以下命令: 1. 使用`git add .`将所有修改添加到暂存区。 2. 使用`git cz`或者`npm run commit`执行提交命令。 3. 如果想要限制提交内容按照规范来，可以使用...
git-commit-lint-vscode:vscode一款git 规范化提交插件
05-17
在日常的开发中,目前主流的代码管理工具就是 git 了,当我们对代码进行改动了,首先得git commit提交到本地仓库,git 规定了提交时必须填写提交信息作为改动说明,保存 commit 历史中,可以找到历史代码,也方便他人 ...
Git Commit提交规范
最新发布
qq_55262450的博客
10-13 477
Git Commit提交规范
Git的Commit提交规范
何以解忧唯有杜康
07-17 740
Git提交规范 格式 type <scope> : subject 1、type（必须） 必须要填写，这是表明此次commit的类型，具体有一下几种类型： feat：新功能 fix：修复bug docs：文档改变 style：代码格式改变 refactor：重构某个功能 perf：性能优化 test：增加测试 build：构建项目，如替换了构建工具 revert：撤销上次的commit chore：构建过程或者辅助工具的变动 2、scope（可选）用于说明此次commit提交作用的范围，例如
git commit的提交规范
初郁
06-16 1427
格式 每次提交，Commit message 包括三个部分：Header（标题），Body（内容详情） 和 Footer（结尾）。 其中 Header是必须的，Body 和 Footer可以省略。 <type>(<scope>): <subject> // 空一行 <body> // 空一行 <footer> Header部分 只有一行，包括两个字段：type（必需）和subject（必需）。 type 用于说明commit的类别，只允许有以
git commit提交规范
axzzy的博客
11-03 2483
📈 (上升趋势图) :chart_with_upwards_trend : 添加分析或跟踪代码。🏁 (旗帜) :checkered_flag : 修复 Windows 下的问题。🌐 (地球) :globe_with_meridians : 国际化与本地化。✅ (白色复选框) :white_check_mark : 增加测试。💚 (绿心) :green_heart : 修复 CI 构建问题。🐧 (企鹅) :penguin : 修复 Linux 下的问题。🔒 (锁) :lock : 修复安全问题。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值