引言
各家公司其实都有自己的提交规范,有各种各样的规则
我这里就是简单写一下业内通用的git提交规范
规范
提交范围
一般需要限定一个具体的部分进行提交,而不是所有写完的东西一起提交,有以下几种:
- 一个狭义上的功能模块
- 前端开发当中的一个页面(比如登录页面)
- 肉眼可见的一个模块,比如抽离出来的一个选择框组件
- 后端开发的一个接口函数
- 后端开发的一个类/方法/代码块
尽量不要将提交内容进行混杂上传,也方便leader
进行审核和review
。
作为开发而言,限定提交范围的文件,也方便以后对于部分代码的回退和查找。
提交文本
提交内容一般分为这样的结构:
【提交类型】:提交文本
提交类型是指以下几种:
- 【feat含义】:表示新增功能
- 【debug含义】:通常用于表示调试
- 【fix:含义】:表示修复错误
- 【docs:含义】:表示对文档的变动
- 【style:含义】:表示对代码格式的变动
- 【refactor: 含义】:表示对代码的重构
- 【perf:含义】:表示与性能优化相关的变动
- 【test:含义】:表示增加测试
- 【chore:含义】:表示对构建过程或辅助工具的变动
- 【revert:含义】:用于回滚到以前的版本
- 【merge:含义】:表示进行代码合并
- 【sync:含义】:表示同步主线或分支的Bug
- 【build: 含义】:用于提交影响构建系统的更改
而后面的提交文本,主要是叙述这一次修改包括哪些内容,影响范围等信息