This repository has been archived by the owner on Feb 22, 2023. It is now read-only.
Add instructions to use volta
to install node in the READMe
#2038
Labels
📄 aspect: text
Concerns the textual material in the repository
✨ goal: improvement
Improvement to an existing user-facing feature
🟨 priority: medium
Not blocking but should be addressed soon
Problem
We've gotten at least two newer contributors confused about which Node version to use. We pin the node version using Volta, but do not specifically direct the reader of the README to initialise volta in the repository. This seems to be a gap in the assumptions of what we think people will know on their own.
Description
Add a new bit to the README before the
pnpm
installation instructions to runvolta install node@16.15.0
. I believe there's a way to get volta to automatically install Node at the pinned version (I thought that was the entire point) but I haven't found it in the docs yet and I don't have time right now to research it further. If whoever is working on this can figure that out, make sure the instructions specify to follow that method. Maybe it has something to do with usingvolta run pnpm dev
instead ofvolta run pnpm
? Additionally, we should add to check the package.json volta pinned version to see which version of Node the project currently expects (if that is indeed our canonical node version for the project).Alternatives
Additional context
Implementation
The text was updated successfully, but these errors were encountered: