Skip to content
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

Document yarn 1.x usage for contributors #24

Merged
merged 1 commit into from
Oct 17, 2022
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: 10 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,16 @@

## Setup

Run `npm install` to install the dependencies.
First make sure you have yarn 1.x (classic) installed. If you are on yarn 2 or 3, you can use yarn 1.x by issueing the following command:

Run the tests with `npm run test`.
```bash
yarn set version classic
```

Run the linter with `npm run lint`.
Run `yarn install` to install the dependencies.

Run the typechecker with `npm run typecheck`.
Run the tests with `yarn run test`.

Run the linter with `yarn run lint`.

Run the typechecker with `yarn run typecheck`.