github.com/verdaccio
1
0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-11-08 23:25:51 +01:00
Code Releases Wiki Activity

docs: improve pnpm development setup info in CONTRIBUTING.md (#2392)

Browse Source
This commit is contained in:
Justin Johansson 2021-08-28 17:00:41 +09:30 committed by GitHub
parent 586f1b0684
commit 7c75776c84
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@ -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