Git提交规范指南_github commit规范

作者：煮酒与君饮 | 2024-06-21 21:33:42

踩

github commit规范

1.规范的必要性

在开发过程中，Git每次提交代码，都需要写Commit message（提交说明），例如：

git commit -m "hello git!"
1

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

git commit
1

一般来说，commit message 应该清晰明了，说明本次提交的目的，规范的Commit message有很多好处：

每次提交，Commit message 都包括三个部分：Header，Body 和 Footer

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
1
2
3
4
5

为了方便使用，我们避免了过于复杂的规定，格式较为简单，Header 是必需的，Body 和 Footer 可以省略：

<type>(<scope>): <subject>
// 注意冒号 : 后有空格
// 如 feat(miniprogram): 增加了小程序模板消息相关功能
1
2
3

scope选填表示commit的作用范围，如数据层、视图层，也可以是目录名称

subject必填用于对commit进行简短的描述

1.以动词开头，使用第一人称现在时，比如change，而不是changed或changes
2.第一个字母小写
3.结尾不加句号，影响美观
1
2
3

type必填表示提交类型，值有以下几种：

如果当前 commit 用于撤销以前的 commit，则必须以revert:开头，后面跟着被撤销 Commit 的 Header

例如：

revert: feat(pencil): add 'graphiteWidth' option
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
1
2

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

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

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/煮酒与君饮/article/detail/744300