Git提交规范

一. 修改类型

每个类型值都表示了不同的含义,类型值必须是以下的其中一个:

  • feat:提交新功能
  • fix:修复了bug
  • docs:只修改了文档
  • style:调整代码格式,未修改代码逻辑(比如修改空格、格式化、缺少分号等)
  • refactor:代码重构,既没修复bug也没有添加新功能
  • perf:性能优化,提高性能的代码更改
  • test:添加或修改代码测试
  • chore:对构建流程或辅助工具和依赖库(如文档生成等)的更改

二.代码回滚

代码回滚比较特殊,如果本次提交是为了恢复到之前的某个提交,那提交消息应该以

"revert:"开头,后跟要恢复到的那个提交的标题。然后在消息正文中,应该写上"This reverts commit ",其中""是要还原的那个提交的SHA值。

三.影响范围

范围不是固定值,它可以是你提交代码实际影响到的任何内容。例如location、 b r o w s e r 、 browser、 browser、compile、rootScope、ngHref、ngClick、ngView等,唯一需要注意的是它必须足够简短。

当修改影响多个范围时,也可以使用"*"。

四.标题

标题是对变更的简明描述:

  • 使用祈使句,现在时态:是"change"不是"changed"也不是"changes"
  • 不要大写首字母
  • 结尾不要使用句号

五.正文

正文是对标题的补充,但它不是必须的。和标题一样,它也要求使用祈使句且现在时态,正文应该包含更详细的信息,如代码修改的动机,与修改前的代码对比等。

六. 页脚

任何Breaking Changes(破坏性变更,不向下兼容)都应该在页脚中进行说明,它经常也用来引用本次提交解决的GitHub Issue。

Breaking Changes应该以"BREAKING CHANGE:"开头,然后紧跟一个空格或两个换行符,其他要求与前面一致。

七、参考链接

https://github.com/angular/angular.js/commits/master

https://github.com/angular/angular.js/blob/master/CHANGELOG.md

https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commitguidelines

https://docs.google.com/documen

相关推荐
y小川15 分钟前
【git】移除远端已删除的git分支
git
OsDepK9 小时前
项目快速Git至仓库(完整版)
大数据·git·elasticsearch·搜索引擎
妙码生花12 小时前
使用git更新ai-go-admin框架
前端·人工智能·git·golang·typescript·php
朝阳58113 小时前
如何用 AI 自动生成规范的 Git 提交信息:从暂存区 diff 到 Conventional Commit
人工智能·git
hudawei99613 小时前
有未保存的修改,不能切换分支
git·git stash·stash
康一夏14 小时前
Git Commit 规范实践:Angular Commit 规范 + Commitlint 自动化验证
git·自动化·commit msg·commit规范
LayZhangStrive17 小时前
Git - 使用IDEA和git上传本地项目到Gitee远程仓库
git·gitee·idea
云泽80818 小时前
Git 版本控制系统(上):架构原理与操作入门
linux·git·架构
绝世唐门三哥18 小时前
Git - git stash 语法演进与实战指南
前端·git
梨想橙汁19 小时前
Git 分支详解:创建切换、合并分支、冲突解决实战
前端·git