格式要求:
标题行:50个字符以内,描述主要变更内容
主体内容:更详细的说明文本,建议72个字符以内。 需要描述的信息包括:
- 为什么这个变更是必须的? 它可能是用来修复一个bug,增加一个feature,提升性能、可靠性、稳定性等等
- 他如何解决这个问题? 具体描述解决问题的步骤
- 是否存在副作用、风险?
尾部:如果需要的化可以添加一个链接到issue地址或者其它文档,或者关闭某个issue。
示例如下:
样式 : feat(location): 接入登录API
登录功能与服务器对接
<type>(<scope>) : <subject>
<body>
<footer>
其中 type 的值可以有
.feat :新功能
.fix :修复bug
.doc :文档改变
.style :代码格式改变
.refactor :某个已有功能重构
.perf :性能优化
.test :增加测试
.build :改变了build工具 如 grunt换成了 npm
.ci :更改CI配置文件或脚本(例如:Travis,Circle,BrowserStack,SauceLabs,Docker)
.chore :其他不会修改src或测试文件的更改
.revert :撤销上一次的 commit
scope :用来说明此次修改的影响范围
.all :表示影响面大 ,如修改了网络框架 会对真个程序产生影响
.location :表示影响小,某个小小的功能
.module :表示会影响某个模块 如登录模块、首页模块 、用户管理模块等等
subject: 用来简要描述本次改动,概述就好了,不超过50个字符
body :具体的修改信息 应该尽量详细
footer :放置写备注啥的,如果是 bug ,可以把bug id放入
网友评论