Skip to content

Commit

Permalink
[SDPA-604] Update docs for testing
Browse files Browse the repository at this point in the history
  • Loading branch information
tim-yao committed Jul 17, 2018
1 parent 9498f0a commit 0d1cedb
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Ripple is a Vue.js component pattern library for SDP.

## Intro

This git repo is a monorepo which contains all Ripple component packages. [View all Ripple componet packages](src/components/).
This git repo is a monorepo which contains all Ripple component packages. [View all Ripple componet packages](packages/).

This git repo also contains a style guide site which uses [Storybook](https://storybook.js.org/) and can be used for local development environment.

Expand Down Expand Up @@ -51,6 +51,15 @@ npm start
npm run lint
```

### Test

``` bash
# We uses Jest for unit test and snapshots test
npm test
```

Before commit changes, run test first. If new Ripple components changed, we should update snapshots by `npm test -- -u`. Then add it in commit.

## Export as a Static App

We can export this Ripple storybook site as a stacic app.
Expand Down

0 comments on commit 0d1cedb

Please sign in to comment.