约定式提交:日常工作中经常用到git,方便别人也是方便自己,学习一下提交规范

约定式提交

格式

<类型>[可选 范围]: <描述>

[可选 正文]

[可选 脚注]

详细说明

类型:说明本次提交的类型

类型 解释
feat 新增功能
fix 修复bug
docs 仅修改了文档
style 修改了代码风格,不影响代码逻辑
refactor 代码重构,没有新增功能也没有修复bug
perf 性能优化
test 增加或修改测试用例
build 编译脚本
ci CI CD相关
chore 杂项,不牵扯代码修改,比如增加了一个工具
revert 回退

范围:可选

格式:用圆括号括起来,一个名词描述当前修改范围

描述:可选

详细描述本次提交的动机和与之前的差异

脚注:可选

不兼容的变更(BREAKING CHANGE): 如果当前代码与上一个版本不兼容,需要在此处说明。必须以 BREAKING CHANGE: 开头,后面跟上描述。
关闭 Issue(Closes): 如果此次提交解决了某个 Issue,可以在这里关联。例如:Closes #123, Fixes #456, #789

示例:

fix(spec): 修改视频录制类型值
视频录制,1为一直录制,现修改为事件录制。
BREAKING CHANGE: 视频录制协议变更