Git commit message规范及编写方法

最新推荐文章于 2023-11-22 15:35:50 发布

haorenSW7

最新推荐文章于 2023-11-22 15:35:50 发布

阅读量716

点赞数

分类专栏： Git 文章标签： git

本文链接：https://blog.csdn.net/haorenSW7/article/details/103949970

版权

Git 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

说明：
1、规范：整理描述一下自己目前对 Angular规范 的理解，主要用于指导自己平时工作中commit message的编写，仅供参考；后期自己的使用扩展后，再补充；
2、编写：列举2种方法编写commit message。

Git commit message规范及编写方法

【1】规范
【2】编写方法
- 【2.1】方法一：直接在Git Bash中编写
- 【2.2】方法二：在弹出框中编写

【1】规范

【1.1】message基本格式

标准格式如下：

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

但目前开发过程中，scope省略，footer几乎不使用，所以常用格式如下：

<type>: <subject>
// 空行
<body>

【1.2】type选择

仅列举目前经常使用的

feat:		新增功能或内容
fix:		修复bug
style:		不改变代码运行的改动（可能修改了代码文件，但代码运行逻辑未变，比如：命名空间、换行、空格、分号和注释等）
refactor:	不改变功能，但改变了功能的实现方式
docs:		修改项目中的文档
chore:		项目中的琐事（与软件逻辑无关的变更，比如生成路径，文档生成方式等）

【1.3】subject和body编写

因为：

commit message是为了方便以后回顾的；
一次commit有可能会包含多处相对独立的修改（当然，应该尽量分开commit）;

所以：

subject 尽量简洁，仅简单描述最主要的那一个修改
body 尽量详细，先描述最主要的修改（什么功能，实现方式，多行叙述），再描述其他修改；
body 中每个修改用一个序号标识（1、2、3…）

【2】编写方法

【2.1】方法一：直接在Git Bash中编写

使用命令：

git commit -m "<commit message>"

输入多行方法：
1、先输入一个引号“ " ”，回车换行，如下图；

2、全部输入完成后，再输入一个引号“ " ”，回车提交。
输入多行时，如果输错，解决方法：
1、先按Ctrl + C，结束当前输入，如下图；

2、按Up 键，恢复之前的输入，如下图；

3、按Left键，移动光标，可以修改任意位置，如下图；

4、修改正确后，继续添加提交即可，如下图。