Skip to content

Commit dff12d6

Browse files
specify node version in contribution guide and add .nvmrc (#510)
1 parent c89cf26 commit dff12d6

File tree

3 files changed

+235
-6
lines changed

3 files changed

+235
-6
lines changed

.github/CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,19 @@ Alternatively, if you'd prefer to keep things to the GitHub UI, you can follow t
3636

3737
If you are uncomfortable using Git, you can also check out [this YouTube video](https://youtu.be/RPagOAUx2SQ) to do this all using the GitHub Desktop app.
3838

39+
## How can I test my changes before submitting a PR?
40+
41+
There are a few tools you'll need to install in order to run our test suites locally:
42+
43+
- [yarn](https://classic.yarnpkg.com/lang/en/docs/install): we use yarn to manage dependencies (instead of npm)
44+
- [node 16.0.0 (or newer)](https://nodejs.org/en/download/): the tests will likely run on earlier versions of node, but if you'd like your changes to be formatted automatically when you commit then you will need to be on node 16 or greater
45+
- [nvm](https://github.com/nvm-sh/nvm#installing-and-updating): while not required, we recommend using nvm to manage multiple versions of node on the same machine
46+
47+
With everything installed, in the repository root (whatever directory contains the `package.json` file) you can run
48+
49+
- `yarn format:verify` and `yarn lint:md` to validate markdown file contents
50+
- `yarn test` to validate `content/` directory structure
51+
3952
## I submitted a PR but tests are failing, how do I fix them?
4053

4154
Here are some common issues and resolutions:

.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
16.13.1

0 commit comments

Comments
 (0)