Skip to content

Commit e7b8d50

Browse files
afontculmiller1990
authored andcommitted
(docs) Update CONTRIBUTING.md (#1390)
(docs) Remove npm references from Contributing
1 parent e171f58 commit e7b8d50

File tree

1 file changed

+4
-10
lines changed

1 file changed

+4
-10
lines changed

Diff for: .github/CONTRIBUTING.md

+4-10
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Hi! I’m really excited that you are interested in contributing to Vue Test Uti
2222

2323
- It's OK to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging.
2424

25-
- Make sure `npm test` passes. (see [development setup](#development-setup))
25+
- Make sure `yarn test` passes. (see [development setup](#development-setup))
2626

2727
- If adding new feature:
2828

@@ -38,28 +38,22 @@ Hi! I’m really excited that you are interested in contributing to Vue Test Uti
3838

3939
You will need [Node.js](http://nodejs.org) **version 6+**
4040

41-
Vue Test Utils is a monorepo. It contains a root package.json for running scripts across the project. The code is inside separate packages in the `packages` directory. The project uses [lerna](https://lerna.js.org/) to manage the workspaces.
41+
Vue Test Utils is a monorepo. It contains a root `package.json` for running scripts across the project. The code is inside separate packages in the `packages` directory. The project uses [lerna](https://lerna.js.org/) to manage the workspaces and should be run using [yarn](https://yarnpkg.com/lang/en/).
4242

4343
After cloning the repo, run:
4444

4545
```bash
4646
$ yarn
4747
```
4848

49-
Or with npm:
50-
51-
```bash
52-
npm i && npm run bootstrap
53-
```
54-
5549
### Commonly used NPM scripts
5650

5751
```bash
5852
# run unit tests with mocha-webpack
59-
$ npm run test:unit
53+
$ yarn test:unit
6054

6155
# run the full test suite, include linting / type checking
62-
$ npm test
56+
$ yarn test
6357
```
6458

6559
There are some other scripts available in the `scripts` section of the `package.json` file.

0 commit comments

Comments
 (0)