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测试用例