From 59cf405aed4bbc8fb1e25a05f70c5038f53acac4 Mon Sep 17 00:00:00 2001
From: cookfront <cookfront@gmail.com>
Date: Thu, 20 Apr 2017 10:38:29 +0800
Subject: [PATCH] add license and issue_template

---
 .github/CONTRIBUTING.md          | 43 ++++++++++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE.md        | 11 ++++++++
 .github/PULL_REQUEST_TEMPLATE.md | 24 ++++++++++++++++++
 LICENSE                          | 22 ++++++++++++++++
 README.md                        |  4 +--
 5 files changed, 102 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..142e840ca
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,43 @@
+# Vant Contributing Guide
+
+## 开发环境
+
+当你克隆好仓库后，运行：
+
+```shell
+yarn || npm i
+```
+
+### 常用的npm scripts
+
+```shell
+# watch和自动build，并启动一个静态服务器
+$ npm run dev
+
+# 代码规范校验
+$ npm run lint
+
+# unit test watch
+$ npm run test:watch
+
+# test
+$ npm run test
+
+# 打包
+$ npm run dist
+
+# gh-pages分支deploy
+$ npm run deploy
+```
+
+### 项目目录结构
+
+- build：打包配置
+- docs：文档目录
+  - examples-dist：手机端md文件，自动生成，请勿改动
+  - examples-docs：PC端文档md文件
+  - src：文档页项目代码
+- lib：打包后生成的文件
+- packages：组件目录，每个组件是一个目录
+- src：主文件以及一些公用的`mixins`和`utils`
+- test：测试用例
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 000000000..37fcc833c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,11 @@
+### 请认真写 PR 的标题，会用于生成 change log。
+
+**Do you want to request a *feature* or report a *bug*?**
+
+**What is the current behavior?**
+
+**If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via https://jsfiddle.net or similar (template: https://jsfiddle.net/n879nke7/).**
+
+**What is the expected behavior?**
+
+**Which versions of Vant and Vue, and which browser / OS are affected by this issue? Did this work in previous versions of Vant?**
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 000000000..83bd77bef
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,24 @@
+### Before submitting a pull request, please make sure the following is done:
+
+### 提交 PR 前请确保完成以下内容:
+
+1. Fork [the repository](https://github.com/youzan/vant) and create your branch from `master`.
+2. Follow the [contributing guide](./CONTRIBUTING.md) to setup your develop environment.
+2. If you've added code that should be tested, add tests!
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes (`npm test`).
+5. Make sure your code lints (`npm run lint`).
+6. Describe your pull request.
+
+### 请认真写 PR 的标题，会用于生成 change log。
+
+### Please remove the above lines when you submit this pull request, also please fill in the changes you've made in this pull request.
+
+### 提交 PR 前 请把以上内容删除，并填写以下内容。
+
+Fixes #xx(issue number here), remove this line if no related issue.
+
+Changes you made in this pull request:
+
+- some change
+- another change
diff --git a/LICENSE b/LICENSE
index 4a98424b9..759985dec 100644
--- a/LICENSE
+++ b/LICENSE
@@ -5,3 +5,25 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+The MIT License (MIT)
+
+Copyright (c) 2016 ElemeFE
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
index 09a1981da..ddb99b733 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,9 @@
 <a href="https://github.com/youzan/"><img alt="有赞logo" width="36px" src="https://img.yzcdn.cn/public_files/2017/02/09/e84aa8cbbf7852688c86218c1f3bbf17.png" alt="youzan">
 </p></a>
 <p align="center">
-    <img alt="项目logo" src="https://img.yzcdn.cn/public_files/2017/02/06/ee0ebced79a80457d77ce71c7d414c74.png">
+    <img alt="项目logo" src="https://img.yzcdn.cn/upload_files/2017/04/20/FlkVrSlOr-SGK9qQqtilN6-IFZyT.png">
 </p>
-<p align="center">Vue Mobile UI at YouZan</p>
+<p align="center">A Vue.js 2.0 Mobile UI at YouZan</p>
  
 ## 一、安装