diff --git a/README.md b/README.md index f51e2f506d..292ee668fb 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ Having issues? See [FAQs](./docs/faqs.md). ### NodeJS -We develop on this library with the version of node defined in `.node-version`. We run the test suite against the major released versions of node that are still in active LTS and not development releases. Specific versions are defined in the workflow: `.github/workflows/build-and-test.yml`. Those are the versions we exxpect to support, if you are using a pre-release or development version of node you may run into unexpected issues. +We develop on this library with the version of node defined in [`.node-version`](.node-version). We run the test suite against the major released versions of node that are still in active LTS and not development releases. Specific versions are defined in the workflow: `.github/workflows/build-and-test.yml`. Those are the versions we expect to support, if you are using a pre-release or development version of node you may run into unexpected issues. Having issues? See [FAQs](./docs/faqs.md). diff --git a/docs/contributing.md b/docs/contributing.md index fe69498615..3dc312e76b 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -26,7 +26,14 @@ We welcome contributions in the form of comments, issues, or pull requests with ## Environment setup -1. Use the node environment manager of your choice, but make sure you have the required version specified in `.node-version`. We recommend using [nodenv](https://github.com/nodenv/nodenv) to manage your node versions, but you can also use [homebrew](https://brew.sh/). More info can be found here: [how to install Node.js](https://nodejs.dev/how-to-install-nodejs) +1. Use the node environment manager of your choice, but make sure you have the required version specified by the project. + - The version required by the project can be found in [`.node-version`](../.node-version). + - We recommend using a single tool version manager such as [mise-en-place](https://mise.jdx.dev/), [asdf](https://asdf-vm.com/), or (specific to just Node) [nodenv](https://github.com/nodenv/nodenv) to manage your node version on this project. + If you already have a preferred node version manager installed, use it. + + > [!NOTE] + > If using asdf, you must [enable `legacy_version_file`](https://asdf-vm.com/manage/configuration.html#legacy-version-file) to have the tool version picked up from `.node-version` + > Mise supports `.node-version` [as a default](https://mise.jdx.dev/configuration.html#idiomatic-version-files). If you're having trouble, make sure that setting is not set to false. 2. Use [yarn](https://yarnpkg.com) to manage JS packages.