add license and issue_template

This commit is contained in:
cookfront
2017-04-20 10:38:29 +08:00
parent c7a662adda
commit 59cf405aed
5 changed files with 102 additions and 2 deletions

43
.github/CONTRIBUTING.md vendored Normal file
View File

@@ -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-docsPC端文档md文件
- src文档页项目代码
- lib打包后生成的文件
- packages组件目录每个组件是一个目录
- src主文件以及一些公用的`mixins``utils`
- test测试用例

11
.github/ISSUE_TEMPLATE.md vendored Normal file
View File

@@ -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?**

24
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -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