Git Commit规范

参考资料:

Git、Github、Gitkraken 学习笔记-小蒋不素小蒋

你可能已经忽略的git commit规范-前端森林

示例:

feat(views):登录后将用户重定向到请求的页面

http://gitlab.xxx.com/production-team/xxx/issues/171

用户在登录后被重定向到主页,这比在重定向到登录表单之前重定向到他们最初请求的页面要有用得多。

* 在session中存储请求的路径
* 登录成功后重定向到存储的位置

格式:

1、第一行 type(scope): subject

  • type:说明commit的类型

            feat:新增feature功能

              fix:修复bug

           docs:仅仅修改了文档,如readme.md

           style:仅仅是对格式进行修改,如逗号、缩进、空格等。不改变代码逻辑

    refactor:代码重构,没有新增功能或修复bug

             perf:优化相关,如提升性能、用户体验等

             test:测试用例,包括单元测试、集成测试

          chore:改变构建流程、或者增加依赖库、工具等

          revert:版本回滚

  • scope(可选):说明commit影响范围,比如: views, component, utils, test...

  • subject:commit目的简短的描述,不超过50字

2、第二行提供 / 解决了什么 issue

如果是 github / gitlab ,直接 # + issues id 即可。

3、第三行详细描述72字左右,可以回答

为什么这一改变是必要的?

它如何解决这个问题?

有什么副作用吗?

原文地址:https://www.cnblogs.com/wattmelon/p/14332096.html