Skip to content

Commit 6bdc08f

Browse files
committed
📚 docs(docs): 更新文档
1 parent cdfd2e4 commit 6bdc08f

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,34 @@ npm i code-genius
1616
npm i -g code-genius
1717
```
1818

19-
## 终端命令
19+
## commit 命令介绍
20+
21+
生成符合 Angualr 规范的提交内容,支持命令模式和询问模式;
22+
23+
### 命令模式
24+
25+
```bash
26+
codeg commit -t fix -s feat -d 修复xx功能的xxBug
27+
```
28+
29+
| 选项 | 描述 |
30+
| --------------------------------- | ------------ |
31+
| -t, --type \<type\> | 添加修改类型 |
32+
| -s, --scope \<scope\> | 填写修改范围 |
33+
| -d, --description \<description\> | 填写修改描述 |
34+
35+
### 询问模式
36+
37+
```bash
38+
codeg commit
39+
40+
1. 请选择提交类型
41+
2. 请选择提交范
42+
3. 请输入提交描述
43+
4. 要在提交信息中显示内置的 emoji 表情吗?
44+
```
45+
46+
## 命令
2047

2148
| 命令 | 参数 | 默认值 | 功能描述 |
2249
| ---------- | ---------------------------------------------------------------------------------------- | --------- | --------------------------------------------------- |

0 commit comments

Comments
 (0)