Skip to content

Commit

Permalink
docs: fix the serve process
Browse files Browse the repository at this point in the history
  • Loading branch information
js87zz committed Jul 7, 2021
1 parent 7002304 commit 942f7cf
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,15 @@ Unsure where to begin contributing to TOAST UI? You can start by looking through
### Development WorkFlow
- Set up your development environment
- Make change from a right branch
- Be sure the code passes `npm run lint`, `npm run test`
- Be sure the code passes `npm run lint:all`, `npm run test:types:all`, `npm run test:all`
- Make a pull request

### Development environment
- Prepare your machine node and it's packages installed.
- Checkout our repository
- Install dependencies by `npm install && bower install`
- Start webpack-dev-server by `npm run serve`
- Install dependencies by `npm install`
- Build toastmark by `npm run build toastmark`
- Start snowpack-dev-server by `npm run serve`

### Make changes
#### Checkout a branch
Expand All @@ -61,7 +62,7 @@ Unsure where to begin contributing to TOAST UI? You can start by looking through
Run `npm run eslint` and make sure all the tests pass.

#### Test
Run `npm run test` and verify all the tests pass.
Run `npm run test:all` and verify all the tests pass.
If you are adding new commands or features, they must include tests.
If you are changing functionality, update the tests if you need to.

Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ Fork `main` branch into your personal repository. Clone it to local computer. In
```sh
$ git clone https://github.com/{your-personal-repo}/tui.editor.git
$ npm install
$ npm run build toastmark
$ npm run test editor
```

Expand Down

0 comments on commit 942f7cf

Please sign in to comment.