Skip to content

Commit 3f174ba

Browse files
committed
A CONTRIBUTING commit specs
1 parent a604b05 commit 3f174ba

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,37 @@ npm run docs
2424
npm run test
2525
```
2626

27+
**Commit 注释规范**
28+
29+
注释结构:`TYPE` `MODULE` `CONTENT`
30+
31+
如:
32+
33+
```
34+
F docs 修复文档链接
35+
A CLS 新增valueFilterName
36+
U chart 修改纬度描述
37+
```
38+
39+
TYPE 只允许使用下面的标识:
40+
41+
```
42+
* A: 新增功能(Add Feature)
43+
* U: 更新功能(Update)
44+
* F: 修复bug(Fix)
45+
* D: 废弃功能(Deprecated)
46+
```
47+
48+
49+
* scope是变更范围的描述,为可选项,允许下面2个标识:
50+
51+
```
52+
* 全局: 修改的内容会影响到项目全局
53+
* 变更模块名: 若修改的内容仅在部分模块内,则指明变更的模块
54+
```
55+
56+
57+
2758
如果你有好的意见或建议,欢迎给我们提 Issues 或 Pull Requests。
2859

2960
[腾讯开源激励计划](https://opensource.tencent.com/contribution) 鼓励开发者的参与和贡献,期待你的加入。

0 commit comments

Comments
 (0)