目录
1、背景
目标
按照一定的规范写 commit messages,可以
在git push
代码之前(工具/脚本自动)检测commit messages。规范提交信息。
规范提交信息的目的:
- 生成 CHANGELOG.md
- 识别不重要的提交
- 在浏览 Git 历史时提供更多信息
在git push
代码之前检测commit messages
的工具(部署在git服务器上,用户每次提交commit messages
都会被检测)
- commitlint
- husky
2、Angular规范
按照Angular规范,commit message 分3个部分:head, body, footer
head: <type> (scop): subject
type: feat, fix, docs, style, refactor, test, chore, revert, perf, build
score: 影响范围
subject: 简短描述(动词开头,首字母小写,结尾不加.)
body: 详细描述
footer: (1) 不兼容改动;(2) 关闭issue
3、实例
docs(changelog): update changelog to beta.5
fix(release): need to depend on latest rxjs and zone.js
The version in our package.json gets copied to the one we publish, and users need the latest of these.
feat的修改
feat(影响论坛的相关模块):增加点赞功能
(这里是空行)
论坛跟帖增加点赞功能,增加用户体验……
(这里是空行)
解决了名字ID冲突bug
fix的提交
fix(影响论坛的相关模块):修改点赞的bug
(这里是空行)
修改点赞大拇指颜色不变红的bug……
(这里是空行)
close #2143
test的提交
test:增加测试并发登录
(这里是空行)
增加测试并发登录的代码,并发用户量可以设置
docs的提交
docs:增加工程说明文档
(这里是空行)
怎加工程说明文档 《xxxxx工程说明.doc》
……
revert 有特殊的格式
# head: revert: <要被撤销的commit的head>
# body: This reverts commit <commit-hash>.
# eg:
revert: docs add README.md
This reverts commit a2d04c0b914785e4ff0cdf4baeea84d