Skip to content

Commit a5d8091

Browse files
committed
docs(contributing): included nvm set-up details
for #27
1 parent edf681c commit a5d8091

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

CONTRIBUTING.md

+18
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,24 @@ and want to attempt your commit again, you can use the `git cz --retry` command
6565
to use the previous wizard answers rather than answering the same way a second
6666
time.
6767

68+
## Environment Configuration
69+
70+
### Node / npm
71+
72+
We define an expected node in each project using [nvm](https://github.com/nvm-sh/nvm)
73+
to help enable consistency between contributors as well as CI.
74+
75+
Once you have `nvm` installed, you can use `nvm install` after cloning to
76+
configure your local node version to match what is expected for the project
77+
(`nvm use` will also work for versions that you already have installed). Avoid
78+
upgrading `npm` independently so that the installed version remains the one
79+
installed with the node version. This will help reduce noise between commits
80+
within the `package-lock.json` file.
81+
82+
If you use `nvm` in many projects, you might consider using [avn](https://github.com/wbyoung/avn)
83+
and [avn-nvm](https://github.com/wbyoung/avn-nvm) to automatically switch to
84+
configured versions when changing into a directory.
85+
6886

6987
[commit-convention-link]: https://conventionalcommits.org
7088
[commit-convention-badge]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg

0 commit comments

Comments
 (0)