From 728ca70c79a24c5d6895779065c7a185d824a652 Mon Sep 17 00:00:00 2001
From: Jimmy Song <rootsongjc@gmail.com>
Date: Fri, 19 May 2017 10:54:57 +0800
Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=E5=A6=82=E4=BD=95=E8=B4=A1?=
 =?UTF-8?q?=E7=8C=AE=E8=AF=B4=E6=98=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/README.md b/README.md
index 930b26e9a..3e6fb4248 100644
--- a/README.md
+++ b/README.md
@@ -70,6 +70,33 @@ gitbook pdf . ./kubernetes-handbook.pdf
 pandoc --latex-engine=xelatex --template=pm-template input.md -o output.pdf
 ```
 
+## 如何贡献
+
+### 提issue
+
+如果你发现文档中的错误，或者有好的建议，不要犹豫，欢迎[提交issue](https://github.com/rootsongjc/kubernetes-handbook/issues/new)。
+
+### 发起Pull Request
+
+当你发现文章中明确的错误或者逻辑问题，在你自己的fork的分支中，创建一个新的branch，修改错误，push到你的branch，然后在[提交issue](https://github.com/rootsongjc/kubernetes-handbook/issues/new)后直接发起Pull Request。
+
+### 贡献文档
+
+**本书文档的组织规则**
+
+- 如果要创建一个大的主题就在最顶层创建一个目录；
+- 所有的图片都放在最顶层的`images`目录下，原则上文章中用到的图片都保存在本地；
+- 所有的文档的文件名使用英文命名，可以包含数字和中划线，不要使用下划线，为了生成网站时，分享URL时候的方便，中文会重新编码；
+- `etc`、`manifests`目录专门用来保存配置文件；
+
+**添加文档**
+
+1. 在该文章相关主题的目录下创建文档；
+2. 在`SUMMARY.md`中在相应的章节下添加文章链接；
+3. 在文章相应的主题的头文档，即以该主题命名的文档中添加链接；
+4. 执行`gitbook server`测试是否保存，然后访问 http://localhost:4000 查看该文档是否出现在相应主题的目录下；
+5. 对该文档有卓越贡献的人将被加入到**贡献者**名单中；
+
 ## 贡献者
 
 [Jimmy Song](http://rootsongjc.github.io/about)