docs: update readme, add conventional commits #1096 (#1143)

* docs: update readme, add conventional commits
pull/1146/head
包子 3 years ago committed by GitHub
parent 3795eddcf5
commit f10605fd51
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 16
      README.md
  2. 17
      README_zh.md

@ -115,6 +115,22 @@ app.Run()
* Website: [go-kratos.dev](https://go-kratos.dev) * Website: [go-kratos.dev](https://go-kratos.dev)
* QQ Group: 716486124 * 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 ## License
Kratos is MIT licensed. See the [LICENSE](./LICENSE) file for details. Kratos is MIT licensed. See the [LICENSE](./LICENSE) file for details.

@ -113,6 +113,23 @@ app.Run()
* [Discord Group](https://discord.gg/BWzJsUJ) * [Discord Group](https://discord.gg/BWzJsUJ)
* Website: [go-kratos.dev](https://go-kratos.dev) * Website: [go-kratos.dev](https://go-kratos.dev)
* QQ Group: 716486124 * 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 ## Sponsors and Backers
![kratos](docs/images/alipay.png) ![kratos](docs/images/alipay.png)

Loading…
Cancel
Save