Skip to content

Commit

Permalink
docs: improve pnpm development setup info in CONTRIBUTING.md (verdacc…
Browse files Browse the repository at this point in the history
  • Loading branch information
Justin Johansson authored Aug 28, 2021
1 parent 586f1b0 commit 7c75776
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,25 @@ The Verdaccio project is split into several areas:
## Development Setup

Verdaccio uses [_pnpm_](https://pnpm.js.org/) as package manager for development
in this repository. Please install the latest one:
Verdaccio uses [pnpm](https://pnpm.io) as the package manager for development in this repository.

If you are using pnpm for the first time the [pnpm configuration documentation](https://pnpm.io/configuring) may be useful to avoid any potential problems with the following steps.

**Note**: pnpm uses npm's configuration formats so check that your global `.npmrc` file does not inadvertently disable package locks. In other words, your `.npmrc` file **should not** contain

```
package-lock=false
```

This setting would cause the `pnpm install` command to install incorrect versions of package dependencies and the subsequent `pnpm build` step would likely fail.

To begin your development setup, please install the latest version of pnpm globally:

```
npm i -g pnpm
```

First step is installing all dependencies:
With pnpm installed, the first step is installing all dependencies:

```
pnpm install
Expand Down

0 comments on commit 7c75776

Please sign in to comment.