From 2ee4a25af4d009a53a7da76d4d176d3e7f08bb6b Mon Sep 17 00:00:00 2001
From: yihong0618 <zouzou0208@gmail.com>
Date: Wed, 24 May 2023 18:53:16 +0800
Subject: [PATCH] doc: add Contribution guide

---
 README.md    | 4 ++++
 README.zh.md | 4 ++++
 2 files changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 18dd30f80..8e36d5103 100644
--- a/README.md
+++ b/README.md
@@ -215,6 +215,10 @@ The achievements of this project are thanks to the technical community, especial
 - [ChatGLM](https://github.com/THUDM/ChatGLM-6B) as the base model
 - [llama_index](https://github.com/jerryjliu/llama_index) for enhancing database-related knowledge using [in-context learning](https://arxiv.org/abs/2301.00234) based on existing knowledge bases.
 
+## Contribution
+
+- Please run `black .` before submitting the code.
+
 <!-- GITCONTRIBUTOR_START -->
 
 ## Contributors
diff --git a/README.zh.md b/README.zh.md
index b84671da2..1d80b747d 100644
--- a/README.zh.md
+++ b/README.zh.md
@@ -218,6 +218,10 @@ python tools/knowledge_init.py
 - [ChatGLM](https://github.com/THUDM/ChatGLM-6B) 基础模型
 - [llama-index](https://github.com/jerryjliu/llama_index) 基于现有知识库进行[In-Context Learning](https://arxiv.org/abs/2301.00234)来对其进行数据库相关知识的增强。
 
+# 贡献
+
+- 提交代码前请先执行 `black .`
+
 <!-- GITCONTRIBUTOR_START -->
 
 ## 贡献者