📃一、前言
该指南内容主要是去描述你应该在项目进行过程中所需遵守的基础规范。在Git仓库管理的过程中,为了减少开发或者其他工作过程中因选择何种方式提交而产生困惑,我们强烈建议你们在其项目中遵循这个指南。
🎬二、提交信息
👀1、信息结构
提交信息由三个不同的部分构成,这些部分均由空行分隔:标题、可选的消息体和可选的注释。其布局大致如此:
1 | 类型:主题 |
标题由消息类型和主题构成。
👀2、类型
类型位于在标题内,有以下几种可能:
| 类型 | 作用 |
|---|---|
| feature(feat) | 新增特性(feature) |
| fix | 修复 Bug(bug fix) |
| docs | 修改文档(documentation) |
| style | 代码格式修改(white-space,formatting,missing semi colons,etc) 格式、分号缺失等,代码无变动 |
| refactor | 代码重构(refactor) |
| perf | 改善性能(A code change that improves performance) |
| test | 测试(when adding missing tests) 测试添加、测试重构等,生产代码无变动 |
| build | 变更项目构建或外部依赖 (例如 scopes: webpack、gulp、npm 等) |
| ci | 更改持续集成软件的配置文件和 package 中的 scripts 命令,例如 scopes:Travis,Circle等 |
| chore | 构建任务更新、程序包管理器配置等,生产代码无变动 |
| revert | 代码回退 |
👀3、标题
主题不得超过50个字符,首字母大写,末尾不加句号。
以祈使语气描述提交的任务,而不是其已完成的任务。例如,使用 change…,而不是 changed 或 changes 。
👀4、信息正文
并不是所有的提交信息都复杂到需要主体,因此这是可选内容,仅在提交信息需要一定的解释和语境时使用。消息体是用于解释提交任务的内容和原因,而不是方法。
在编写正文时,需要在标题和正文间加一个空行,且每行的内容应控制在72个字符内。
👀5、注释
注释是可选内容,用于引用问题跟踪的 ID 。
👀6、提交信息示例
1 | Feature: 总结变动的内容,保持在50个字符内 |
示例:
Sourcetree 软件 提交示例(携带签名)

❤ enjoy it.