From 62f74e7f7c1c904df88813799c6ad15a5515cb37 Mon Sep 17 00:00:00 2001
From: nick <nick_php@163.com>
Date: Fri, 26 Apr 2019 17:24:41 +0800
Subject: [PATCH] =?UTF-8?q?:pencil2:=20=E6=B7=BB=E5=8A=A0=E8=B4=A1?=
 =?UTF-8?q?=E7=8C=AE=E6=8C=87=E5=8D=97?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 CONTRIBUTING.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++
 README.md       |  4 +++
 SUMMARY.md      |  3 +++
 3 files changed, 72 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..cd142ce
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,65 @@
+# 贡献指南
+
+非常感谢您关注 PHPer 必知必会的 Linux 命令项目，在提交您的贡献之前，请务必认真阅读以下准则。
+
+- [问题反馈](#Issue)
+- [开发指南](#develop)
+    - [常用脚本命令（npm scripts）](#npm-scripts)
+    - [项目结构](#dir-spec)
+    - [提交请求（pull request）](#pull-request)
+- [文档说明](#docs-spec)
+
+<a id="Issue"></a>
+## 问题反馈
+
+- 请避免提交重复的 Issue，在提交之前搜索现有的 Issue 。
+- 请确定 Issue 的类型，并在 Issue 内容描述清晰，我们将根据内容对 Issue 打上对应的 label 。
+
+<a id="develop"></a>
+## 开发设置
+
+项目依赖 [GitBook](https://github.com/GitbookIO/gitbook) ，需要安装 [Node.js](https://nodejs.org/) 版本8+ ，下载项目到本地后安装依赖 `gitbook install` 。
+
+<a id="npm-scripts"></a>
+### 常用脚本命令
+
+``` bash
+# 启动本地 HTTP 服务器用来本地预览
+$ gitbook serve
+
+# 编译 markdown 文档为 html 文件
+$ gitbook build
+```
+
+<a id="dir-spec"></a>
+### 项目结构
+
+```
+phper-linux-gitbook      
+├── images              # 文档图片
+├── node_modules        # 第三方依赖库
+├── styles              # 样式文件
+├── README.md           # 文档首页
+├── .gitattributes      # git 配置文件，可以设计导出时忽略文件等
+├── .gitignore          # git 忽略文件配置列表
+├── book.json           # gitbook 配置
+└── ...                 # 内容文件
+```
+
+<a id="pull-request"></a>
+### 提交请求（pull request）
+
+1. fork [Nick233333/phper-linux-gitbook](https://github.com/Nick233333/phper-linux-gitbook)
+1. 把个人仓库（repository）克隆到电脑上，并安装所依赖的插件。
+1. 开始编辑文件，可以通过命令 `gitbook serve` 预览编辑的效果。
+1. 推送（push）分支。
+1. 建立一个新的合并申请（pull request）并描述变动。
+
+<a id="docs-spec"></a>
+## 文档说明
+
+- 文档基于 Markdown 格式编写。
+- 使用中文半角标点符号。
+- 名词区分大小写。
+- 英文、代码、链接前后添加空格。
+- 新增文档需要添加文档对应的目录配置
\ No newline at end of file
diff --git a/README.md b/README.md
index 4e5e656..65243fe 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,10 @@
 
 主要为了方便其他 ~~新手~~ 开发者学习 `Linux` , 也为学习 `Linux` 做下总结与记录，本书内容会偏向实用，不会有过多的理论知识，太底层的知识我也无法一一讲解，毕竟我只是一个 `Linux` 熟练工，书中内容我会尽个人的最大努力进行总结与归类，做到每个章节的内容可以独立阅读，帮助读者通过某些命令实现实现具体的功能。书中内容会陆续更新，无法一步到位。
 
+## 欢迎你的加入
+
+个人能力有限，水平也有限，希望有想法的朋友提交代码，一起完善它！阅读 [贡献指南](CONTRIBUTING.md) 查看更多开发者帮助。
+
 ## 知识共享许可协议
 
 ![知识共享许可协议](https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png)  
diff --git a/SUMMARY.md b/SUMMARY.md
index 361ea6a..3762516 100644
--- a/SUMMARY.md
+++ b/SUMMARY.md
@@ -69,4 +69,7 @@
 ## 参考资料
 * [书籍](http://billie66.github.io/TLCL/book/)	
 
+## 贡献指南
+* [贡献](CONTRIBUTING.md)
+