Git Commit message 编写规范

最新推荐文章于 2024-02-23 19:03:00 发布

LING超

最新推荐文章于 2024-02-23 19:03:00 发布

阅读量974

点赞数

文章标签： git github java

本文链接：https://blog.csdn.net/qq_16013529/article/details/130291486

版权

介绍

在 Git 中，每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。这个操作将通过 git commit 完成。

git commit -m "hello world"

上面代码的-m参数，就是用来指定 commit mesage 的。

如果一行不够，可以只执行git commit，就会跳出文本编译器，让你写多行。

git commit

格式

Commit message 包括三个部分：Header，Body 和 Footer。可以用下方的格式表示它的结构。

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

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

不管是哪一个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免自动换行影响美观。

Header

Header部分只有一行，包括三个字段：type（必需）、scope（可选）和subject（必需）。
type

feat：新功能（feature）
fix：修补bug
docs：文档（documentation）
style：格式（不影响代码运行的变动）
refactor：重构（即不是新增功能，也不是修改bug的代码变动）
test：增加测试
chore：构建过程或辅助工具的变动

如果 type 为 feat 和 fix ，则该 commit 将肯定出现在 Change log 之中。其他情况（docs、chore、style、refactor、test）由你决定，要不要放入 Change log，建议是不要。

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

subject
subject是 commit 目的的简短描述，不超过50个字符。

以动词开头，使用第一人称现在时，比如change，而不是changed或changes
第一个字母小写
结尾不加句号（.）

Body

Body 部分是对本次 commit 的详细描述，可以分成多行。下面是一个范例。

ore detailed explanatory text, if necessary.  Wrap it to 
about 72 characters or so. 

Further paragraphs come after blank lines.

- Bullet points are okay, too
- Use a hanging indent

有两个注意点。

（1）使用第一人称现在时，比如使用change而不是changed或changes。

（2）应该说明代码变动的动机，以及与以前行为的对比。

Footer

Footer 部分只用于两种情况。

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

BREAKING CHANGE: isolate scope bindings definition has changed.

    To migrate the code follow the example below:

    Before:

    scope: {
      myAttr: 'attribute',
    }

    After:

    scope: {
      myAttr: '@',
    }

    The removed `inject` wasn't generaly useful for directives so there should be no code using it.

2、关闭 Issue
如果当前 commit 针对某个issue，那么可以在 Footer 部分关闭这个 issue 。

Closes #234

也可以一次关闭多个 issue 。

Closes #123, #245, #992

Revert

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

revert: feat(pencil): add 'graphiteWidth' option

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.

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

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

idea 中应用

安装插件 Git Commit Template
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-xfkAuKQZ-1682064855429)(/uploads/houduanjishutixi-202003/images/m_cf5b0b6c823ee018f58683be809753c1_r.png)]

安装完成后提交页面会多了一个按钮，如果没有请重启一下idea
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-jYdp7lmy-1682064855432)(/uploads/houduanjishutixi-202003/images/m_b87b641b147b1faf35763759bce414c2_r.png)]

点击按钮弹出窗口
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-eqAG5V91-1682064855434)(/uploads/houduanjishutixi-202003/images/m_99e775c6fbccd32c92ddef608d319c89_r.png)]

type描述

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

例子：
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-DR9p4vq6-1682064855436)(/uploads/houduanjishutixi-202003/images/m_71e7c90bfce39f6c0fa341da4396ee02_r.png)]

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-3zlf3TjK-1682064855439)(/uploads/houduanjishutixi-202003/images/m_2fef41f13ac25b24df13ee7ad61a704e_r.png)]

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-kfEstf1U-1682064855443)(/uploads/houduanjishutixi-202003/images/m_f06069273e751773f47c64366db9a02b_r.png)]

总结

在我们开发中，直接在idea中装插件使用，其中必填为type和short description；大部分情况下使用的是7个type类型，特殊情况也可以选择插件上面其它的type或者填写其它项以达到更清晰的描述此次提交的原因。

LING超

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
1
评论
Git Commit message 编写规范

在 Git 中，每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。这个操作将通过 git commit 完成。上面代码的-m参数，就是用来指定 commit mesage 的。如果一行不够，可以只执行git commit，就会跳出文本编译器，让你写多行。git commit在我们开发中，直接在idea中装插件使用，其中必填为type和short description；
复制链接

扫一扫