Git 协作规范

在个人仓库中编码可以随心所欲，但是作为一个团队合作编码时需要符合一定规范来提升团队效率，因此本文记录下 Git 协作规范；

Git 协作规范

完整流程参考：https://nvie.com/posts/a-successful-git-branching-model/

master：稳定版本代码，不能在master 直接开发。
hotfix：基于master，并最后合并到master和develop。生命周期较短，用了修复bug或小粒度修改发布。
develop: 开发中代码，一般从feature branches、release 或hotfix合并过来。
release：用于发布测试代码，基于develop，修改后又合并回develop。稳定后合并进入master并打tag，生命周期很短，只是为了发布。不同版本的release不一样，比如release/1.0.0、release/2.0.0。
feature：功能feature开发的分支，基于develop，各个开发者自己维护，最终合并进入develop。一般按开发的功能命名，也可以按开发者名字命名。

Git commit 编写规范

完整文档参考：https://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html

每次提交，Commit message 都包括三个部分：Header，Body 和 Footer。

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

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

不管是哪一个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免自动换行影响美观。

Header部分只有一行，包括三个字段：type（必需）、scope（可选）和subject（必需）。

（1）type

type用于说明 commit 的类别，只允许使用下面7个标识。

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

如果type为feat和fix，则该 commit 将肯定出现在 Change log 之中。其他情况（docs、chore、style、refactor、test）由你决定，要不要放入 Change log，建议是不要。

（2）scope

scope用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。

（3）subject

subject是 commit 目的的简短描述，不超过50个字符。

以动词开头，使用第一人称现在时，比如change，而不是changed或changes
第一个字母小写
结尾不加句号（.）

Body

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

More detailed explanatory text, if necessary. Wrap it to
about 72 characters or so.
Further paragraphs come after blank lines.
Bullet points are okay, too
Use a hanging indent

有两个注意点。

（1）使用第一人称现在时，比如使用change而不是changed或changes。

（2）应该说明代码变动的动机，以及与以前行为的对比。

Footer 部分只用于两种情况。

（1）不兼容变动

如果当前代码与上一个版本不兼容，则 Footer 部分以BREAKING CHANGE开头，后面是对变动的描述、以及变动理由和迁移方法。

BREAKING CHANGE: isolate scope bindings definition has changed.
To migrate the code follow the example below:
Before:
scope: {
myAttr: ‘attribute’,
}
After:
scope: {
myAttr: ‘@’,
}
The removed inject wasn’t generaly useful for directives so there should be no code using it.

（2）关闭 Issue

如果当前 commit 针对某个issue，那么可以在 Footer 部分关闭这个 issue 。