Git 提交规范
Git 的 commit message 一般分为三个部分 Header,Body 和 Footer。
<type>(<scope>): <subject>
# 空一行
<body>
# 空一行
<footer>
其中,Header 是必需的,Body 和 Footer 可以省略。
1. HEAD
提交类型type
用于说明 commit 的类别,有下面几种
build:
编译相关的修改,例如发布版本、对项目构建或者依赖的改动
chore:
其他修改,比如改变构建流程、或者增加依赖库、工具等
ci:
持续集成修改
docs:
文档修改
feat:
新特性、新功能
fix:
修改bug
perf:
优化相关,比如提升性能、体验
refactor:
代码重构(即不是新增功能,也不是修改bug的代码变动)
revert:
回滚到上一个版本
style:
代码格式修改,注意不是css修改(不影响代码运行的变动)
test:
测试用例修改作用域scope
用来说明本次Commit影响的范围,即简要说明修改会涉及的部分,比如数据层、控制层、视图层等,
主题subject
简单说明此次提交的内容
2. Body
对本次 commit 的详细描述,可以分成多行
例子
在平时的提交中,我们也可以只包含header,比如我们修改了登录页面的某个功能,那么可以这样写 Commit Message。
feat(登录):添加登录接口
辅助填写工具(研究中)
文本自动输入器autotyper。
安装包存放地址:\10.1.135.8\导远内网文件服务器\光电产品\B1(R外网到内网)\99-其他\MHH\SourceTree
通过快捷键输入的方式,输入模板,再自行填写。插入脚本:commitizen。
较繁琐。