规范文档 — 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 | 打包 |