mirror of
https://github.com/go-kratos/kratos.git
synced 2025-03-17 21:07:54 +02:00
* docs: update readme, add conventional commits
This commit is contained in:
parent
3795eddcf5
commit
f10605fd51
16
README.md
16
README.md
@ -115,6 +115,22 @@ app.Run()
|
||||
* Website: [go-kratos.dev](https://go-kratos.dev)
|
||||
* QQ Group: 716486124
|
||||
|
||||
## Conventional commits
|
||||
The structure of the commit message should look like the following
|
||||
```text
|
||||
<type>[optional scope]: <description>
|
||||
|
||||
[optional body]
|
||||
|
||||
[optional footer(s)]
|
||||
```
|
||||
|
||||
The information should be commit in the following format:
|
||||
- fix: simply describe the problem that has been fixed
|
||||
- feat(log): simple describe of new features
|
||||
- deps(examples): simple describe the change of the dependency
|
||||
- break(http): simple describe the reasons for breaking change
|
||||
|
||||
## License
|
||||
Kratos is MIT licensed. See the [LICENSE](./LICENSE) file for details.
|
||||
|
||||
|
17
README_zh.md
17
README_zh.md
@ -113,6 +113,23 @@ app.Run()
|
||||
* [Discord Group](https://discord.gg/BWzJsUJ)
|
||||
* Website: [go-kratos.dev](https://go-kratos.dev)
|
||||
* QQ Group: 716486124
|
||||
|
||||
## Conventional commits
|
||||
提交信息的结构应该如下所示:
|
||||
```text
|
||||
<type>[optional scope]: <description>
|
||||
|
||||
[optional body]
|
||||
|
||||
[optional footer(s)]
|
||||
```
|
||||
|
||||
提交信息应按照下面的格式:
|
||||
- fix: simply describe the problem that has been fixed
|
||||
- feat(log): simple describe of new features
|
||||
- deps(examples): simple describe the change of the dependency
|
||||
- break(http): simple describe the reasons for breaking change
|
||||
|
||||
## Sponsors and Backers
|
||||
|
||||

|
||||
|
Loading…
x
Reference in New Issue
Block a user