Skip to content

Commit

Permalink
docs: remove refs to yarn
Browse files Browse the repository at this point in the history
  • Loading branch information
bd82 committed Jan 4, 2024
1 parent 448f4e8 commit 6979028
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,19 +40,16 @@ In general:

### pre-requisites

- [Yarn](https://yarnpkg.com/lang/en/docs/install/) >= 1.4.2
- Yarn rather than npm is needed as this mono-repo uses [yarn workspaces](https://yarnpkg.com/lang/en/docs/workspaces/).
- A [maintained version](https://nodejs.org/en/about/releases/) of node.js
- [pnpm](https://pnpm.io/installation) >= 8
- An [LTS version](https://nodejs.org/en/about/releases/) of node.js
- This package is targeted and tested on modern/supported versions of node.js only.
Which means 10+ at the time of writing this document.
- [commitizen](https://github.com/commitizen/cz-cli#installing-the-command-line-tool) for managing commit messages.

### Initial Setup

The initial setup is trivial:

- clone this repo
- `yarn`
- `pnpm i`

### Committing Changes

Expand All @@ -75,7 +72,7 @@ as the Parser initialization (which happens once per process) can take 10-20ms.
[mocha]: https://mochajs.org/
[istanbul]: https://istanbul.js.org/

- To run the tests run `yarn test` in a specific subpackage.
- To run the tests run `pnpm test` in a specific subpackage.

### Test Coverage

Expand All @@ -91,7 +88,7 @@ as the Parser initialization (which happens once per process) can take 10-20ms.
This project does not use any compilation step (Babel/TypeScript), this means that the full build
does not generate any artifacts for runtime.

- To run the full **C**ontinuous **I**ntegration build run `yarn ci` in in either the top level package or a specific subpackage.
- To run the full **C**ontinuous **I**ntegration build run `pnpm ci` in in either the top level package or a specific subpackage.

### Release Life-Cycle.

Expand Down

0 comments on commit 6979028

Please sign in to comment.