Skip to content

Commit 94ae562

Browse files
committed
docs(tool): add commitizen/commitlint/huksy/conventional-changelog/generator-standard-readme
1 parent 8ca0cf1 commit 94ae562

File tree

4 files changed

+31
-29
lines changed

4 files changed

+31
-29
lines changed

docs/tool/[Commitizen]信息交互工具.md renamed to docs/tool/commitizen.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11

2-
# [Commitizen]信息交互工具
2+
# [Commitizen]信息提交
33

44
[Commitizen](http://commitizen.github.io/cz-cli/)是一个提交日志工具,辅助开发者使用提交规则
55

66
## 预配置
77

8-
需要安装`NodeJS`,参考:[nodeJS安装](https://hexo-guide.readthedocs.io/zh_CN/latest/node/nodeJS%E5%AE%89%E8%A3%85.html)
8+
* 安装`NodeJS`
99

10-
## 安装`Commitizen`
10+
## 安装Commitizen
1111

1212
# 全局安装
1313
$ npm install -g commitizen
1414

15-
## 安装`Adapter`
15+
## 安装Adapter
1616

1717
`Commitizen`支持多种不同的提交规范,可以安装和配置不同的适配器实现
1818

docs/tool/[CommitLint][Husky]消息校验工具.md renamed to docs/tool/commitlint-husky.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11

2-
# [CommitLint][Husky]消息校验工具
3-
4-
参考:[commitlint](https://conventional-changelog.github.io/commitlint/#/)
2+
# [CommitLint][Husky]消息校验
53

64
使用`commitizen`可以规范化提交信息,同样的,可以设置工具来检查提交信息是否符合格式要求
75

@@ -122,4 +120,8 @@
122120

123121
language: node_js
124122
script:
125-
- commitlint-travis
123+
- commitlint-travis
124+
125+
## 相关阅读
126+
127+
* [commitlint](https://conventional-changelog.github.io/commitlint/#/)
Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,17 @@
11

2-
# [standard-version]版本自动化及CHANGELOG生成
3-
4-
参考:
5-
6-
[conventional-changelog/standard-version](https://github.com/conventional-changelog/standard-version)
7-
8-
[Closing issues using keywords](https://help.github.com/en/articles/closing-issues-using-keywords)
9-
10-
[如何维护更新日志](https://keepachangelog.com/zh-CN/1.0.0/)
11-
12-
## conventioanl-changelog
13-
14-
参考:
15-
16-
[conventional-changelog-cli](https://www.cnblogs.com/zivxiaowei/p/10089201.html)
2+
# 版本自动化及CHANGELOG生成
173

184
使用工具[conventional-changelog](https://www.npmjs.com/package/conventional-changelog)进行`CHANGELOG`文件的自动生成
195

20-
### 安装
6+
## 安装
217

228
全局安装:
239

2410
```
2511
$ npm install -g conventional-changelog-cli
2612
```
2713

28-
### 使用
14+
## 使用
2915

3016
基本使用命令如下:
3117

@@ -47,9 +33,7 @@ $ conventional-changelog -p angular -i CHANGELOG.md -s -r 0
4733

4834
* 参数`-r`默认为`1`,设为`0`将重新生成所有版本的变更信息
4935

50-
### 快捷方式
51-
52-
参考:[五、生成 Change log](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html)
36+
## 快捷方式
5337

5438
在工程`package.json`中加入以下脚本
5539

@@ -66,3 +50,15 @@ $ conventional-changelog -p angular -i CHANGELOG.md -s -r 0
6650
```
6751
$ npm run changelog
6852
```
53+
54+
## 相关阅读
55+
56+
* [conventional-changelog/standard-version](https://github.com/conventional-changelog/standard-version)
57+
58+
* [Closing issues using keywords](https://help.github.com/en/articles/closing-issues-using-keywords)
59+
60+
* [如何维护更新日志](https://keepachangelog.com/zh-CN/1.0.0/)
61+
62+
* [conventional-changelog-cli](https://www.cnblogs.com/zivxiaowei/p/10089201.html)
63+
64+
* [五、生成 Change log](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html)

mkdocs.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,4 +76,8 @@ nav:
7676
- 拉取指定远程分支到本地: git/advanced/拉取指定远程分支到本地.md
7777
- 远程分支替换本地分支: git/advanced/远程分支替换本地分支.md
7878
- 为每个项目单独设置用户名和邮箱: git/advanced/为每个项目单独设置用户名和邮箱.md
79-
- ERROR: git/error.md
79+
- ERROR: git/error.md
80+
- '[Commitizen]消息提交': tool/commitizen.md
81+
- '[CommitLint][Husky]消息校验': tool/commitlint-husky.md
82+
- README生成器: tool/generator-standard-readme.md
83+
- '版本自动化及CHANGELOG生成': tool/standard-version.md

0 commit comments

Comments
 (0)