Skip to content

Commit 5bf6914

Browse files
yugasunxuexb
authored andcommitted
docs: update README (#10)
* docs: update README * docs: update README * docs: remove garbled
1 parent 23bfb7a commit 5bf6914

1 file changed

Lines changed: 28 additions & 8 deletions

File tree

README.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,35 @@
11
# github-bot
22

3-
## list
3+
Github robot
4+
5+
## 功能 - Feature
6+
7+
### Issue
48

59
- [x] 不规范 issue 自动关闭
6-
- [x] 当 issue 标记 label 为 need demo 时,自动回复,需要相关demo
10+
- [x] 当 issue 标记 label 为 `need demo` 时,自动回复,需要相关demo
711
- [x] issue 自动 assign 给指定人员,需要配置 `package.json``config.github-bot.lableToAuthor` 映射
8-
- [x] 当往远程第一次推送新版本号时,自动列出最新版本距离上一版本的 commit log 并发布 release notes ,会把项目 clone 到 `./github/{项目名}/` 去分析 commit log
12+
13+
### Pull Request
14+
915
- [x] 发 PR 时根据打的 label 自动添加指定的 reviewer ,需要配置 `package.json``config.github-bot.lableToAuthor` 映射
10-
- [x] 发 PR 时标题不规范时提醒修改,需要配置 `package.json``config.validate-commit-msg.type` 前缀,标题必须以 `前缀:` 开头
16+
- [x] 发 PR 时标题不规范时提醒修改,需要配置 `package.json``config.validate-commit-msg.type` 功能关键字,标题必须以 `功能关键字:` 开头
1117
- [x] 发 PR 时自动根据标题的 [PR 标题规则](https://github.com/xuexb/github-bot#commit-log-和-pr-标题规则) 前缀生成对应的 label , `feat->enhancement, fix->bug`
1218

13-
## issue 规则
19+
### Release
20+
21+
- [x] 当往远程第一次推送新版本号时,自动列出最新版本距离上一版本的 commit log 并发布 release notes ,会把项目 clone 到 `./github/{项目名}/` 去分析 commit log
22+
23+
## 规则 - Rules
24+
25+
### issue 规则
1426

1527
```
1628
node version: 版本号
1729
url: http://www.example.com
1830
```
1931

20-
## labels 规则
32+
### labels 规则
2133

2234
- invalid - 未定义, 内容 不规范
2335
- need demo - 需要提供预览链接
@@ -28,10 +40,14 @@ url: http://www.example.com
2840
- question - 提问
2941
- wontfix - 不修复的问题
3042

31-
## commit log 和 PR 标题规则
43+
### commit log 和 PR 标题规则
44+
45+
所有标题必须以 `功能关键字:` 开头
3246

3347
> 参考: <http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html>
3448
49+
功能关键字介绍如下:
50+
3551
- feat - 新功能(feature)
3652
- fix - 修补bug
3753
- docs - 文档(documentation)
@@ -41,7 +57,7 @@ url: http://www.example.com
4157
- revert - 撤销
4258
- close - 关闭 issue
4359

44-
60+
示例
4561

4662
```
4763
close: #1, #3
@@ -53,3 +69,7 @@ docs: update install info
5369

5470
- [@yugasun](https://github.com/yugasun/)
5571
- [@xuexb](https://github.com/xuexb/)
72+
73+
## Liscense
74+
75+
MIT

0 commit comments

Comments
 (0)