Skip to content

Remove npm references from Contributing #1390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 4, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 4 additions & 10 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Hi! I’m really excited that you are interested in contributing to Vue Test Uti

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

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

- If adding new feature:

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

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

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.
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/).

After cloning the repo, run:

```bash
$ yarn
```

Or with npm:

```bash
npm i && npm run bootstrap
```

### Commonly used NPM scripts

```bash
# run unit tests with mocha-webpack
$ npm run test:unit
$ yarn test:unit

# run the full test suite, include linting / type checking
$ npm test
$ yarn test
```

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