常用的git提交规范

2021-02-05 10:01:05 阅读：244 来源： 互联网

标签：Body 常用 git Footer xxx 变动 Header 提交 commit

git提交规范

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

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

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

Header
Header部分只有一行，包括两个字段：type（必需）和subject（必需）。
type：commit 的类别，只允许使用下面9个标识。

//注意冒号后面的空格
feat: 新功能（feature）
fix: 修补bug
docs: 文档（documentation）
style: 格式（不影响代码运行的变动）
refactor: 重构（即不是新增功能，也不是修改bug的代码变动）
chore: 构建过程或辅助工具的变动
revert: 撤销，版本回退
perf: 性能优化
test：测试
improvement: 改进
build: 打包
ci: 持续集成

subject是 commit 目的的简短描述，不超过50个字符，以动词开头，使用第一人称现在时，比如修改/修复/增加等。
scope用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。
Body
Body 部分是对本次 commit 的详细描述，可以分成多行。
```
//举个例子
xxx/xxx.vue  修改内容
xxx/xxx.vue  修改内容
```
Footer

Footer 部分只用于两种情况。
1. 不兼容变动
  如果当前代码与上一个版本不兼容，则 Footer 部分以BREAKING CHANGE开头，后面是对变动的描述、以及变动理由和迁移方法。
```
BREAKING CHANGE: 项目webpack升级到4.0版本
xx插件替换成xx插件
```
  2.关闭 bug/需求
```
closes 3056, 11231
```

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

revert: feat(pencil): 回退当前版本667ec到 sssee2

标签：Body,常用,git,Footer,xxx,变动,Header,提交,commit
来源： https://blog.csdn.net/qq_44570971/article/details/113678790

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9

常用的git提交规范

git提交规范