龙空技术网

Git代码提交规范 以及IDEA 和 VSCode插件

程序员干货 599

前言:

此时你们对“ideagit提交代码步骤”大致比较注意,你们都需要学习一些“ideagit提交代码步骤”的相关知识。那么小编也在网摘上汇集了一些关于“ideagit提交代码步骤””的相关知识,希望我们能喜欢,看官们快快来了解一下吧!

一、Git Commit message规范

常用的Git Commit message规范采用的是Angular 规范。

本文参考阮老师的文章介绍:

.

Angular规范中定义的格式有3个内容:

Header

Body

Footer

1、 Header

Header部分有3个字段: type(必需), scope(可选), subject(必需)

type(必需) : Type of change:commit的类别;

scope(可选):Scope of this change:此次commit的影响模块;

subject(必需):Short description:简短地描述此次代码变更的主要内容

(1)type

type用于说明commit的类别,常用的标识如下:

feat:新功能(feature)fix:修补bugdocs:文档(documentation)style: 格式(不影响代码运行的变动,空格,格式化,等等)refactor:重构(即不是新增功能,也不是修改bug的代码变动perf: 性能 (提高代码性能的改变)test:增加测试或者修改测试build: 影响构建系统或外部依赖项的更改(maven,gradle,npm 等等)ci: 对CI配置文件和脚本的更改chore:对非 src 和 test 目录的修改revert: Revert a commit

最常用的就是feat和fix两种type;

(2)scope

scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

(3)subject

subject是 commit 目的的简短描述,不超过50个字符,主要介绍此次代码变更的主要内容。

举个例子:

eg: feat(订单模块):订单详情接口增加订单号字段

其中, feat对应type字段;订单模块对应scope(如果scope有内容,括号就存在);“订单详情接口增加订单号字段”对应subject,简要说明此次代码变更的主要内容。

2、Body

Body 部分是对本次 commit 的详细描述,可以分成多行。

如:

(1)增加订单号字段;

(2)增加了订单退款接口;

日常项目开发中,如果Header中subject已经描述清楚此次代码变更的内容后,Body部分就可以为空。

3、Footer

(1)不兼容变动

(2)关闭 Issue

日常项目中开发,Footer不常用,可为空。

4、Revert

若需要撤销上一次的commit,header部分为:revert: 上一次commit的header内容;

body部分为:This reverts commit xxx,xxx是上一次commit对应的SHA 标识符。

二、IDEA插件Git Commit Template使用

打开 IDE plugin manager (File > Settings > Plugins > Browser repositories > Git Commit Template)

使用三、Git-commit-plugin For Vscode

首先我们需要去 Vscode 插件市场搜索 git-commit-plugin 并且进行安装。

2. 安装完之后可以使用组合键 Command + Shift + P 呼出 指令行,并键入指令 show git commit template 或者点击 git 插件栏上的小图标唤醒插件界面。

3. 根据自己当前提交所要表达的意义,选择对应的 type 类型去编写 commit 信息

标签: #ideagit提交代码步骤 #idea git提交代码步骤 #ideagit提交代码提交不了