From 7c75776c84033f8ae7222d34462d9c4d472b6497 Mon Sep 17 00:00:00 2001 From: Justin Johansson Date: Sat, 28 Aug 2021 17:00:41 +0930 Subject: [PATCH] docs: improve pnpm development setup info in CONTRIBUTING.md (#2392) --- CONTRIBUTING.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ffb7744d8f1f..107f7ea7e84d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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