From f10605fd51ccebe0e1d305f535409866516a87b5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=8C=85=E5=AD=90?= <baozhecheng@foxmail.com>
Date: Sat, 3 Jul 2021 16:58:34 +0800
Subject: [PATCH] docs: update readme, add conventional commits #1096 (#1143)

* docs: update readme, add conventional commits
---
 README.md    | 16 ++++++++++++++++
 README_zh.md | 17 +++++++++++++++++
 2 files changed, 33 insertions(+)

diff --git a/README.md b/README.md
index 1b2695ac2..fbe11ffc6 100644
--- a/README.md
+++ b/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.
 
diff --git a/README_zh.md b/README_zh.md
index 00e91177f..5febb45d3 100644
--- a/README_zh.md
+++ b/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
 
 ![kratos](docs/images/alipay.png)