Skip to content

Commit 4500b65

Browse files
committed
docs: update readme
1 parent a82e096 commit 4500b65

File tree

2 files changed

+27
-3
lines changed

2 files changed

+27
-3
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# tencent-component-toolkit
1+
# Tencent Component Toolkit
22

33
[![npm](https://img.shields.io/npm/v/tencent-component-toolkit)](http://www.npmtrends.com/tencent-component-toolkit)
44
[![NPM downloads](http://img.shields.io/npm/dm/tencent-component-toolkit.svg?style=flat-square)](http://www.npmtrends.com/tencent-component-toolkit)
@@ -13,6 +13,29 @@ Tencent component toolkit.
1313
$ npm install tencent-component-toolkit --save
1414
```
1515

16+
## Development
17+
18+
All `git commit` mesage must follow below syntax:
19+
20+
```bash
21+
type(scope?): subject #scope is optional
22+
```
23+
24+
support type:
25+
26+
```bash
27+
- **feat**: add new feature
28+
- **fix**: fix bug or patch feature
29+
- **ci**: CI
30+
- **chore**: modify config, nothing to do with production code
31+
- **docs**: create or modifiy documents
32+
- **refactor**: refactor project
33+
- **revert**: revert
34+
- **test**: test
35+
```
36+
37+
Most of time, we just use `feat` and `fix`.
38+
1639
## License
1740

18-
MIT License
41+
Copyright (c) 2019-present Tencent Cloud, Inc.

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@
3939
"url": "git+https://github.com/serverless-tencent/tencent-component-toolkit.git"
4040
},
4141
"keywords": [
42-
"template",
42+
"tencent-component",
43+
"tencent-component-toolkit",
4344
"release",
4445
"ci"
4546
],

0 commit comments

Comments
 (0)