关于git commit -m ‘‘书写规范

最新推荐文章于 2024-08-02 23:14:58 发布
最新推荐文章于 2024-08-02 23:14:58 发布
阅读量1.2k 收藏 6
点赞数 2
分类专栏： 前端代码规范 文章标签： git 前端 github
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_46740017/article/details/123087590
版权
本文介绍了Git代码提交的规范，包括Header、Body和Footer的结构。Header中的type字段规定了不同类型的提交，如feat（新功能）、fix（修复bug）、docs（文档更新）等。通过遵循这个规范，可以提高代码管理和协作的效率。示例中展示了如何为添加新功能和修复bug编写合适的提交信息。
摘要由CSDN通过智能技术生成

关于git代码提交描述规范可以参考：约定式提交

Commit message 的格式

Commit message 都包括三个部分：Header，Body 和 Footer。

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

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

Header

type用于说明commit的类型如下

  • feat：新功能（feature）
  • fix：修补bug
  • docs：文档（documentation）
  • style：格式（不影响代码运行的变动）
  • refactor：重构（即不是新增功能，也不是修改bug的代码变动）
  • perf: 优化相关，比如提升性能、体验
  • test：增加测试
  • chore：构建过程或辅助工具的变动
  • revert: 回滚到上一个版本

拓展

type在commit的是否必须存在。

  • feat: 添加新特性
  • fix: 修复bug
  • docs: 仅仅修改了文档
  • style: 仅仅修改了空格、格式缩进、逗号等等，不改变代码逻辑
  • refactor: 代码重构，没有加新功能或者修复bug
  • perf: 优化相关，比如提升性能、体验
  • test: 增加测试用例
  • chore: 改变构建流程、或者增加依赖库、工具等
  • revert: 回滚到上一个版本

实际操作如下

添加了新的系统功能

git commit -m 'feat（全局）：添加支付功能模块'

修改了Bug

git commit -m 'fix（header.jsx）：修复页面轮播'

参考

git commit规范
github官方
阮一峰的网络日志

子禛
关注
专栏目录
怎样写好Git的commit信息
踩风火轮的乌龟
02-09 1万+
从一个开发者的commit日志中，就可以看出他是不是个很好地合作者。这篇文章介绍了写好commit日志需要地规则，跟着这篇文章，让我们成为一个优秀的合作者吧。
Git Commit提交规范总结
拾年一剑 的专栏
02-27 6319
团队协作中，规范的Git提交记录，使提交历史明确可追溯，有助于更好的协作，方便后期代码的开发和维护
【git】如何实现自定义规范git commit -m的提交文案格式
hzxOnlineOk的博客
07-22 430
【代码】【git】如何实现规范git commit -m的格式。
git提交commit信息规范，fix，feat
最新发布
imkaifan的博客
08-02 472
it提交时常见的字段含义，包括新功能（feat）、修复bug（fix）、文档更新（docs）、代码格式调整（style）、重构（refactor）、构建工具更改（chore）、版本回退（revert）、性能提升（perf）、测试相关（test）、代码改进（improvement）、打包操作（build）以及持续集成（ci）
git commit -m
qq_38719039的博客
07-31 1492
细说 commit 的参数详细。 Header包括三个字段：type、scope和 subject。（scope可选） git commit -m 'fix: #512 bug' git commit -m 'feat($login): remember user name' （1）type type用于说明 commit 的类别，只允许使用下面7个标识： feat ： 新功能 fix ： 修补bug docs：文档 style：格式 refactor：重构 test ： 增加测试 chore：
【Git】git commit -m 提交信息约束规范
qq_45677671的博客
09-05 792
git commit -m 提交信息书写格式的约束规范
git commit规范
热门推荐
新之助的学习之路
07-25 1万+
1. git commit说明 我们都知道，Git 每次提交代码，都要写 Commit message（提交说明），否则就不允许提交，这其实就是规范，但输入的说明我们可以随便写，之前我也会随便写，后来看到同事都很规范的写，就学习了一下。 $ git commit -m &quot;hello world&quot; 上面代码的-m参数，就是用来指定 commit mesage 的。 如果一行不够，可以...
gitcommit规范
qq_40517293的博客
05-12 160
git commit -m 规范 先贴链接： 阮一峰老师博客 git message 的格式 包含三个部分： Header Body Footer 其中Header是必要的Body和Footer可以省略 Header Header部分只有一行，包括三个字段：type（必需）、scope（可选）和subject（必需）。 （1）type type用于说明 commit 的类别，只允许使用下面7个标识。 feat：新功能（feature） fix：修补bug docs：文档（documentation）
git commit 规范
qq_32320925的博客
12-01 1239
git commit 规范
angular代码规范_Angular 工具篇之规范化Git版本管理
weixin_35565522的博客
01-13 817
Angular 工具篇系列教程目录：目前很多的项目都已经使用 Git 作为版本控制工具，使用 Git 意味着我们每天都要与 Git Commit Message 打交道。Git Commit Message 看似简单，但实际却很重要。通过 Git Commit Message 我们可以快速地了解本次提交的信息，比如解决了哪个 Bug、优化了什么问题或新增了什么功能等。俗话说得好，无规矩不成方圆。因...
前端工程化之commit规范（代码提交规范）
codingWeb的博客
11-02 1万+
其实commit规范不管是前端还是后端也好，我觉得吧，在任何的工程化的项目中都是不可或缺的部分啦，commit 提交不规范，项目维护和管理起来是极其麻烦的，毕竟每个人都具有自己的个性，commit的格式也是参差不齐 git 可以帮我们很好地管理代码，但是在多人合作的时候，经常会碰到各种随意的 commit message，当你需要会看 commit message 的时候，就会很头疼。 幸运的是我们可以使用工具去处理掉这个问题，不让这种小问题影响到项目的进展 首先来看一下被业界广泛认可的 Angular
git命名规范和协作开发流程
前端程序猿的博客
01-17 838
git命名规范和协作开发流程
Cz工具集使用介绍 - 规范Git提交说明
weixin_33890526的博客
04-27 9652
在多人协作的项目中，如果Git的提交说明精准，在后期协作以及Bug处理时会变得有据可查，项目的开发可以根据规范的提交说明快速生成开发日志，从而方便开发者或用户追踪项目的开发信息和功能特性。 本文主要内容： 介绍符合Angular规范（需要翻墙）的提交说明 介绍提交说明工具集cz（适配器、校验以及日志）的使用方法 介绍供开发者快速生成项目cz工具集的Vue CLI 3插件@ziyi2/ui-cz ...
Git commit 规范
jingbin_的博客
03-20 399
git提交估计也快上万次了，每次不知道怎么写好，今天在网上找到一套规范然后加上常用的一些，总结出来一套 Git commit 规范，没有强制的规定，主要是翻阅以前的日志会更清晰。 type: description type 是 commit 的类别，只允许如下几种标识： fix: 修复bug add: 新功能 update: 更新 refactor : 某个已有功能重构 perf : 性能优...
git commit 详解
weixin_30345055的博客
03-19 4960
git commit 命令用来将本地暂存的修改提交到版本库。 git commit -m '提交信息'。 我们用的比较多的应该就是-m 参数。添加提交信息。 经常手抖的同学可能会知道，git commit直接回车也是可以提交暂存的，只不过输入提交信息的时候是通过调用vim编辑器进行信息编写的。还有就是vim编辑器支持信息回车。 没错，就是这个样子的。 像我最早一次手抖出现这个窗口的时...
Git Commit message 规范
Wiliam的博客
02-07 5101
Git Commit message 规范介绍格式HeaderBodyFooterRevert常用示例featfixdocsstylerefactorperftestchorerevert参考链接 介绍 在 Git 中，每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。这个操作将通过 git commit 完成。 git commit -m "芜湖~起飞" 上面代码的-m参数，就是用来指定 commit message 的。 如果一行不够，可以只执行 git commit
⭐️《Git常用命令》详细讲解·第4篇（git commit -m “commit message“和git commit --amend）
Python老吕的博客
03-28 2846
如果你需要在命令行中提供更多的信息，你可以使用 -m 选项，但是如果你想要在 -m 选项中提供少于或者多于一行的文本，你可以使用 -m 选项，但是如果你想要在 -m 选项中提供少于或者多于一行的文本，你可以使用 git commit 命令而不带 -m 选项，这样Git会打开一个文本编辑器（通常是默认的shell编辑器），你可以在这里输入多行的commit message。这个信息应该清晰地表明所做的更改。如果你想撤销上一次的提交，可以使用 --amend 选项配合 --reset-author 选项。
git commit 提交规范详解
淡淡的博客
08-10 2547
看一个模板 # 样式 : feat(location): 接入登录API # # 登录功能与服务器对接 # &lt;type&gt;(&lt;scope&gt;) : &lt;subject&gt; &lt;body&gt; &lt;footer&gt; #其中 type 的值可以有 # .feat :新功能 # ...
git commit -m和git commit 区别
05-31
`git commit -m` 和 `git commit` 的区别在于提交代码时是否添加提交信息。 `git commit -m` 命令用于将暂存区的修改提交到 Git 代码库中，并且可以添加一条提交信息，描述本次提交的内容。选项 `-m` 后跟着的字符...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值