git commit 提交规范

1. 说明

本文主要介绍使用 git commit 提交代码时如何书写 message,及 message 对应规范,需严格遵循 message 规范。

2. message 提交格式

在执行 git add 后,执行 git commit 时,代码有变动,并需要特殊说明更改内容时,message 信息遵循下方定义的格式。(如没有特殊更改及说明可以使用:git commit -m <message> 提交代码)

message 格式

<type>(<scope>): <subject>
<!-- 空行 -->
<body>
<!-- 空行 -->
<footer>
字段 必须 说明
*<type> 提交类别
<scope> 用于说明 commit 影响的范围,建议填写影响的功能模块
*<subject> commit 目的的简短描述,不超过50个字符
<body> 否(建议填写) 描述当前修改的行为详细信息或修改的目的。
<footer> 一般用于描述BREAKING CHANGE,在项目开发中一般不需要填写,组件研发的工程需要填写。

2.1 *<type> 提交类别

必填<type>commitmessage 中是必须存在的。<type>可以有以下取值

说明
feat 添加新特性
fix 修复bug
docs 仅仅修改了文档
style 仅仅修改了空格、格式缩进、逗号等等,不改变代码逻辑
refactor 代码重构,没有添加新功能或者修复bug
test 增加测试用例
chore 改变构建流程、或者增加依赖库、工具等
revert 回滚到上一个版本

2.2 <scope> 影响范围

非必填(建议填写),<scope> 用于说明 commit 影响的范围,建议填写影响的功能模块。

如果修改影响不止一个 scope,可以使用 * 代替

2.3 *<subject> 简短描述

必填,commit 目的的简短描述,不超过50个字符

  • 以动词开头,使用第一人称现在时,比如 change,而不是changedchanges
  • 第一个字母小写
  • 结尾不加句号

2.4 <body> 详细信息

非必填(建议填写),可描述当前修改的行为详细信息或修改的目的

2.5 <footer> 其他信息

非必填,一般用于描述BREAKING CHANGE,在项目开发中一般不需要填写,组件研发的工程需要填写。

格式:BREAKING CHANGE开头,后面是对变动的描述,以及变动理由和迁移方法。

3. 提交方式

本质上是改变文件 .git/COMMIT_EDITMSG 中的文本,实际提交过程如下(推荐命令行提交)

feat(网盘):添加文件上传接口

- 添加批量文件上传
- 添加生成文件临时下载地址

3.1 命令行提交

Window

window 系统下默认 git 编辑工具是 vim,如无相关基础,建议使用 window 默认的文本编辑器(vim 使用方法

修改 git 默认文本编辑器(cmd/PowerShell 命令行中执行)

git config core.editor notepad

修改后执行 git commit 会弹出文本编辑器。

热后保存并关闭,或执行如下信息:

Linux/Unix

参考vim 使用方法

Mac

参考vim 使用方法

3.2 GUI 提交

IEDA

image.png
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,192评论 6 511
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,858评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,517评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,148评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,162评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,905评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,537评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,439评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,956评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,083评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,218评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,899评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,565评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,093评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,201评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,539评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,215评论 2 358

推荐阅读更多精彩内容