一、为什么需要规范
无规矩不成方圆，编程也一样。Git Commit 规范可能并没有那么夸张，但如果你在版本回退的时候看到一大段糟心的 Commit，恐怕会懊恼不已吧。 所以，严格遵守规范，利人利己。
规范 commit message 的好处
- 首行就是简洁实用的关键信息，方便在 git history 中快速浏览
- 具有详实的 body 和 footer ，可以清晰的看出某次提交的目的和影响
- 可以通过 type 过滤出想要查找的信息，也可以通过关键字快速查找相关提交
- 可以直接从 commit 生成 change log
二、具体规则
分支：
-
1.master：主分支（保护分支），不能直接在master上进行修改代码和提交；
-
2.develop:测试分支，所有开发完成需求提交测试的功能合并到该分支；
-
3.feature(feature-*):新功能开发分支，根据不同需求创建独立的功能分支，开发完成后合并到develop分支；
-
4.hotfix(hotfix-*):bug修复分支，根据实际情况对已发布的版本进行漏洞修复；
-
5.release:预发布分支；
-
主分支名称：master
-
主开发分支名称：develop
-
新功能开发分支名称：feature-or feature/，其中“*” 为新功能简述，如：feature-item-activity-list
-
发布分支名称：release-or release/，其中*为版本号，“release”小写，如：release-1.0.0
-
master的bug修复分支名称：hotfix-or hotfix/，其中*为bug简述，如：hotfix/item-update-bug
Tag(标签)
采用三段式，v版本.里程碑.序号，如v1.2.3
- 架构升级或架构重大调整，修改第1位
- 新功能上线或者模块大的调整，修改第2位
- bug修复上线，修改第3位
- 名称：v*.RELEASE，其中”*“ 为版本号，“RELEASE”大写，如：v1.0.0.RELEASE
ChangeLog
- 版本正式发布后，需要生产changelog文档，便于后续问题追溯。
Git commit日志基本规范
-
Commit message 都包括三个部分：Header，Body 和 Footer
<aside> 💡 注：为了能在 github 以及各种 git 工具中看得更清晰，commit messages 的每一行都不要超过 100 个字符。
</aside>
-
公式：
<type>(<scope>): <subject> // 空一行 <body> // 空一行 <footer> 注意冒号后面有空格。 Header 是必需的，Body 和 Footer 可以省略。 -
Header
-
type
-
用于说明 commit 的类别，只允许使用下面标识。
- feature/feat：新功能(feature)
- fix：修补，bug修复
- docs：文档(documentation)仅文档的修改
- style： 修改格式（空格，格式化，省略分号等），对代码运行没有影响
- refactor：重构（既不是修 bug ，也不是加功能）
- build：构建流程、外部依赖变更，比如升级 npm 包、修改 webpack 配置等
- perf : 优化相关，比如提升性能、体验
- test：增加测试，测试相关
- revert：回滚到上一个版本
- ci : 主要目的是修改项目继续集成流程，构建过程或辅助工具的变动
- chore：不属于以上类型的其他类型
注意：revert 开头
应加上被撤销的提交的 header，
在 body 中应该注明：This reverts commit <hash>. ，hash 指的就是将要被撤销的 commit SHA 。
// 例如 revert: feat(user): add user type This reverts commit ca16a365467e17915f0273392f4a13331b17617d.
-
-
scope
- 用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同，当修改影响超过单个的 scope 时，可以指定为 *
-
subject
- subject 是指更改的简洁描述，长度约定在 50 个字符以内，通常遵循以下几个规范
- 以动词开头，使用第一人称现在时，比如 change ，而不是 changed 或 changes
- 第一个字母小写
- 结尾不加句号（.）
- subject 是指更改的简洁描述，长度约定在 50 个字符以内，通常遵循以下几个规范
-
-
Body
- Body 部分是对本次 commit 的详细描述，可以分成多行。
- 应该说明修改的原因和更改前后的行为对比。
-
Footer
-
示例
// 不兼容变动 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. // 关闭 Issue Closes #234 Closes #123, #245, #992 // 关闭多个
-
示例
feat
feat($browser): onUrlChange event (popstate/hashchange/polling)
Added new event to $browser:
- forward popstate event if available
- forward hashchange event if popstate not available
- do polling when neither popstate nor hashchange available
Breaks $browser.onHashChange, which was removed (use onUrlChange instead)
fix
fix($compile): couple of unit tests for IE9
Older IEs serialize html uppercased, but IE9 does not...
Would be better to expect case insensitive, unfortunately jasmine does
not allow to user regexps for throw expectations.
Closes #392
Breaks foo.bar api, foo.baz should be used instead
style
style($location): add couple of missing semi colons
https://serious-lose.notion.site/Git-Specification-592ff2f7280e47f2a960ab026d3f53c6