规范文档 — Git提交规范

531 阅读1分钟

规范文档 — Git提交规范

前言

工欲善其事,必先利其器。

Commit message 格式

规定提交格式 (不限定中英文):

<type>(<scope>): <subject>
// 注意冒号 : 后有空格
// 例 feat(miniprogram): 增加了小程序模板消息相关功能

解析:

属性解释
scope选填表示 commit 的作用范围,如数据层、视图层,也可以是目录名称。
subject必填用于对commit进行简短的描述。
type必填表示提交类型。

提交类型

类型选项说明
feat新增功能 feature
fix修复 bug
docs文档注释
style代码格式 (不影响代码运行的改动)
refactor重构优化
perf性能优化
test增加测试
chore构建过程或辅助工具改动
revert回退
build打包