jxnblk/mdx-deck
1
1
Fork 0
mirror of https://github.com/jxnblk/mdx-deck.git synced 2024-11-25 07:05:52 +03:00
Code Issues Projects Releases Wiki Activity

Update contributing docs

Browse Source
This commit is contained in:
Brent Jackson 2019-04-13 12:10:30 -04:00
parent de58106147
commit b027338cb4
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
CONTRIBUTING.md
View File

@ -8,10 +8,11 @@ otherwise we'd love to have your help!
## Development
This project is set up as a monorepo using Yarn Workspaces.
1. Clone the repo
2. Install dependencies with `npm install`
3. Build with `npm run prepare`
4. Run `npm start` to see the demo `docs/index.mdx`
2. Install dependencies with `yarn`
3. Run `yarn start` to see the demo `docs/demo.mdx`
### Watch mode
@ -19,12 +20,12 @@ To watch files for changes during development, run `npm run watch`
## Testing
Tests are located in the [`test/`](test) directory.
Tests are located in each package.
Run `npm test`
Run `yarn test`
- Watch Mode: `npm test -- --watch`
- Coverage: `npm test -- --coverage`
- Watch Mode: `yarn test --watch`
- Coverage: `yarn test --coverage`
---