From a5c4f35c994998c14f804d8689742a0985960d93 Mon Sep 17 00:00:00 2001
From: "qingwei.li" <cinwell.li@gmail.com>
Date: Wed, 7 Sep 2016 12:40:16 +0800
Subject: [PATCH] add doc

---
 .github/CONTRIBUTING.md          | 51 ++++++++++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE.md        | 24 +++++++++++++++
 .github/PULL_REQUEST_TEMPLATE.md |  5 ++++
 README.md                        |  5 ++--
 4 files changed, 83 insertions(+), 2 deletions(-)
 create mode 100644 .github/CONTRIBUTING.md
 create mode 100644 .github/ISSUE_TEMPLATE.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 000000000..a95c7cc1e
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,51 @@
+# Element Contributing Guide
+
+Hi! 首先感谢你使用 Element UI。这是一个为开发者、设计师和产品经理准备的一套能让你快速搭建页面的基于 Vue 2.0 的组件库，同时我们还提供了相关设计资源供设计师使用。如果你考虑为 Element 贡献代码的话，请确保阅读下面内容。
+
+## Issue 规范
+- issue 仅仅用来提交 Bug 或 Feature 以及设计相关的内容。如果只是简单的问题，请到 Slack 或 Gitter 里咨询，并且我们会直接关掉。
+
+- 提交 issue 前请搜索下是否有同样的问题已经被 fix 或者回复过了。
+
+- 请确保指明了 Element、Vue 的版本号，以及操作系统和浏览器的版本，最好能提供在线演示的链接。
+
+## Pull Request 规范
+- 请先 fork 一份到自己的项目下，不要直接在仓库下建分支。
+
+- commit 信息要以`[组件名]: 描述信息` 的形式填写，例如 `Button: fix xxx bug`。
+
+- 提交前**不要提交** `lib` 里面打包的文件。
+
+- 执行 `npm run dist` 后可以正确打包文件。
+
+- 为了兼容和最终打包的文件体积考虑，我们的 babel 只引入了 `preset-2015`，所以不建议使用 ES2015 的 API，例如 `Array.prototype.find`、`Object.assign`等。如果有需要，请引入第三方的 polyfill。
+
+- 如果是修复 bug，请给出描述信息在 PR 里。
+
+- 合并代码需要两名维护人员参与：一人进行 review 后留言 lgtm，另一人再次 review，通过后即可合并。
+
+## 开发环境搭建
+首先你需要 Node.js 4+ 和 NPM 3+
+```shell
+npm run dev
+
+# open http://localhost:8085
+```
+
+如果国内用户觉得安装慢可以使用 [npminstall](https://github.com/cnpm/npminstall)
+```shell
+npm i npminstall -g
+npminstall
+npm run dev
+
+# open http://localhost:8085
+```
+
+To build:
+
+```shell
+npm run dist
+```
+
+## 代码规范
+遵循 lint 即可
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 000000000..4224c9093
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,24 @@
+<!--
+Thank you for contributing! Please carefully read the following before opening your issue.
+ -->
+
+ <!-- BUG REPORT TEMPLATE -->
+### Element version
+<!-- 1.0.0-rc.2 -->
+
+### OS/Browers version
+<!-- macOS/Chrome 53 -->
+
+### Vue version
+<!-- 2.0.0-rc.4 -->
+
+### Reproduction Link
+<!-- A minimal JSBin, JSFiddle, Codepen, or a GitHub repository that can reproduce the bug. -->
+<!-- https://npmcdn.com/element-ui/lib/index.js -->
+<!-- https://npmcdn.com/element-ui/lib/theme-default/index.css -->
+
+### Steps to reproduce
+
+### What is Expected?
+
+### What is actually happening?
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 000000000..0e4b65809
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,5 @@
+Please makes sure these boxes are checked before submitting your PR, thank you!
+
+* [ ] Make sure you follow Element's [Contributing Guide](https://github.com/elemefe/element/blob/master/CONTRIBUTING.md).
+* [ ] Rebase before creating a PR to keep commit history clear.
+* [ ] Add some descriptions and refer relative issues for you PR.
diff --git a/README.md b/README.md
index db46d3b12..d1924cc11 100644
--- a/README.md
+++ b/README.md
@@ -68,8 +68,6 @@ Vue.component(Button.name, Button)
 ```
 
 ## development
-
-### Building Tool Installation
 ```shell
 # development => install packages -> build icon etc. -> run webpack
 $ npm run dev
@@ -85,6 +83,9 @@ $ npm run dist
 ## Changelog
 Details changes for each release are documented in the [release notes](https://github.com/ElemeFE/element/releases).
 
+## Contribution
+Please make sure to read the [Contributing Guide](https://github.com/elemefe/element/blob/master/CONTRIBUTING.md) before making a pull request.
+
 ## LICENSE
 MIT