Git提交规范

Tool git

创建时间:2017-09-13 16:23

阅读:

Git Commit规范笔记

便于历史版本查询，功能对比。

1
2
3

git log <last tag> HEAD --pretty=format:%s
$ git log <last release> HEAD --grep feature

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

type

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

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

subject

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

Body 部分是对本次 commit 的详细描述.

Footer 部分只用于两种情况。
（1）不兼容变动
（2）关闭 Issue

1	Closes #234

还有一种特殊情况，如果当前 commit 用于撤销以前的 commit，则必须以revert:开头，后面跟着被撤销 Commit 的 Header。

1
2
3

$ npm install -g conventional-changelog
$ cd my-project
$ conventional-changelog -p angular -i CHANGELOG.md -w

上面命令不会覆盖以前的 Change log，只会在CHANGELOG.md的头部加上自从上次发布以来的变动。

1	conventional-changelog -p angular -i CHANGELOG.md -w -r 0

想生成所有发布的 Change log，运行命令。

{
"scripts": {
    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -w -r 0"
}
}
$ npm run changelog

写入script

转载请注明来源，欢迎对文章中的引用来源进行考证，欢迎指出任何有错误或不够清晰的表达。可以在下面评论区评论，也可以邮件至 jjworking@qq.com