Appearance
git commit 提交规范
- 提交格式：
[<type>]<space><message><type>: 提交内容类型，放置在一对英文中括号内[]，大小写均可<space>: 空格，用于隔开类型与详情<message>: 提交内容描述详情
type 类型说明
- 项目修改类型
| 类型 | 说明 | 描述 |
|---|---|---|
| Create | 创建 | 初次创建项目时使用 |
| Add | 新增 | 新增加的功能等描述 |
| Fix | 修复 | 修复某个 bug 的描述 |
| Mod | 修改 | 在原有的基础上修改代码 |
| Refactor | 重构 | 重构是重写了代码（与Mod相比更具有颠覆性） |
| Merge | 合并 | 在解决代码冲突，合并分支时使用 |
| Migration | 数据库迁移 | 描述具体的数据迁移脚本，及影响范围（包含各语言数据库迁移脚本以及SQL原生脚本） |
- 项目描述类型
| 类型 | 说明 | 描述 |
|---|---|---|
| Docs | 文档 | 更新/新增文档时的描述 |
| Test | 测试 | 增加/修改测试示例代码 |
- 项目发布类型
| 类型 | 说明 | 描述 |
|---|---|---|
| Release | 版本发布 | 发布新的版本时使用，该类型不与其他类型描述共存 |
Example
- [Create] 项目初始化
- [Add] 新增用户管理模块
- [Fix] 修复XXX模块XXX的问题，禅道BUG编号：#XXX
- [Mod] 修改XXX模块XXX接口内XXX的算法逻辑
- [Refactor] 重构了XXX模块XXX接口/方法
- [Merge] 合并XXX分支至XXX分支
- [Migration] 提交迁移（XXX文件）：迁移影响XXX与XXX
- [Docs] 更新XXX模块/方法注释或文档
- [Docs] 更新XXX接口的接口说明文档
- [Test] 新增/调整XXX模块/方法的单元测试或测试脚本
- [Release] version 1.0.0.1