diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d0ddac9871db..f87c88bc0585 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,7 @@ # Getting started -- Ensure you have node version 16 installed (suggestion: v16.5). +Storybook is developed against a specific node version. We recommend using [Volta](https://volta.sh/) as it will automatically install the correct node and yarn version when you first use the repo. If you chose not to use Volta please ensure you you have node version 16 installed (suggestion: v16.5) + - Ensure if you are using Windows to use the Windows Subsystem for Linux (WSL). - Run `yarn start` in the root directory to run a basic test Storybook "sandbox". diff --git a/package.json b/package.json index 562cce14091e..7c606bfbed07 100644 --- a/package.json +++ b/package.json @@ -12,5 +12,9 @@ "test": "cd code; yarn test", "upload-bench": "cd scripts; yarn upload-bench" }, - "packageManager": "yarn@3.5.1" + "packageManager": "yarn@3.5.1", + "volta": { + "node": "16.20.1", + "yarn": "3.5.1" + } }