深圳大演绎科技 开发人员 Git 使用规范

深圳大演绎科技 开发人员 Git 使用规范

一、提交规范

1、提交时commit不得为空

2、格式

提交信息包括两个部分：Header，Body

其中，Header 是必需的，Body 和 Footer 可以省略。

Header:

Header部分只有一行，包括俩个字段：type（必需）和subject（必需）。

: 

type用于说明 commit 的类别，可以使用如下类别（如果一次提交可以有多个类别，使用主要的类别）：

• feat：新功能（feature）
• fix：修补bug
• doc：文档（documentation）
• style： 格式（不影响代码运行的变动）
• refactor：重构（即不是新增功能，也不是修改bug的代码变动）
• test：增加测试
• chore：构建过程或辅助工具的变动

subject是 commit 目的的简短描述。

结尾不加句号（。）

Body

Body 部分是对本次 commit 的详细描述，可以分成多行。下面是一个范例。

- 修改了XXX界面的逻辑，用来处理XXX情况
- 增加相应的单元测试

注意：应该说明代码变动的动机，以及与以前行为的对比。

Footer

3、例子

下面是一个完整的例子：

feat: 添加了分享功能

给每篇博文添加了分享功能

- 添加分享到微博功能
- 添加分享到微信功能
- 添加分享到朋友圈功能

务必清晰简洁