Skip to content

Commit

Permalink
docs: update authors and contributing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JeromeLin committed Apr 3, 2020
1 parent 8e89fd3 commit ee4f64d
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 1 deletion.
10 changes: 9 additions & 1 deletion AUTHORS
Original file line number Diff line number Diff line change
@@ -1,23 +1,31 @@
Jerome Lin <[email protected]>
Cheng007 <[email protected]>
JasonYou <[email protected]>
Lch_XS <[email protected]>
Lin Qun <[email protected]>
Ma Shuangshuang <[email protected]>
Shawn <[email protected]>
Thyiad <[email protected]>
TianGong <[email protected]>
caianfa <[email protected]>
chrisHchen <[email protected]>
develop-zw <[email protected]>
edison-hm <[email protected]>
hezhirong <[email protected]>
hzzheng <[email protected]>
lduoduo <[email protected]>
lsert <[email protected]>
lulu <[email protected]>
ouyangxiaochong <[email protected]>
rou <[email protected]>
sanheng <[email protected]>
ssCassie <[email protected]>
taohongyong <[email protected]>
wang <[email protected]>
whatwewant <[email protected]>
xiaoshuang.li <[email protected]>
xiecheng <565460621@qq.com>
yangpan <yangpan@zhongan.com>
yangtao <[email protected]>
zhiyingzzhou <[email protected]>
zhuxiaozhen <[email protected]>
zwBlogOne <[email protected]>
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contributing to zarm

## Set up
Install to fetch its dependencies after git clone the repo.

```
# npm is not allowed.
$ yarn
```

Then, you can runs Zarm Design website locally.
```
npm run dev
```


## Lint
checks the code style.
```
npm run lint
```

## Test
runs the complete test suite.
```
npm test
```

## Build
compiles TypeScript code to the lib and es directory, creates UMD build of zarm.
```
npm run build
```

0 comments on commit ee4f64d

Please sign in to comment.