Skip to content

Commit a9b421f

Browse files
committed
docs: add .nvmrc and point contributor setup at it
The accessibility check (`make a11y` / `npm run check-a11y`) runs pa11y-ci's sitemap fetch, which breaks on Node 24.17.0+ (node-fetch "Premature close"). Add .nvmrc pinned to the same known-good 24.16.0 CI uses so local runs match CI, and replace the vague "Node.js v20+" guidance in README and CONTRIBUTING with a pointer to it.
1 parent 01ce41f commit a9b421f

3 files changed

Lines changed: 4 additions & 3 deletions

File tree

.nvmrc

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

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Thank you for investing your time in contributing to our project!
1313

1414
- You can preview your changes to the site either:
1515
- Locally, as follows:
16-
- Install Node.js v20+ and run `npm install`
16+
- Install Node.js and run `npm install` (use the version in [`.nvmrc`](.nvmrc); run `nvm use`)
1717
- Run `make serve` (or `npx myst start`)
1818
- Via deploy preview (branch PRs only—not available for fork PRs):
1919
- Open a PR from a branch in this repo
@@ -81,7 +81,7 @@ Here are some resources to help you get started with open source contributions:
8181

8282
- Commit locally as you progress (`git add` and `git commit`)
8383
- To preview your changes:
84-
- Install Node.js v20+ and run `npm install`
84+
- Install Node.js and run `npm install` (use the version in [`.nvmrc`](.nvmrc); run `nvm use`)
8585
- Run `make serve` (or `npx myst start`)
8686
- To check accessibility: run `npm run build` then `npm run check-a11y`
8787
- To make sure your code passes linting and formatting checks, you can:

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The [UC OSPO Network](https://ucospo.net) website, built with [MyST](https://mys
44

55
## Prerequisites
66

7-
- [Node.js](https://nodejs.org) v20+ and npm
7+
- [Node.js](https://nodejs.org) and npm. Use the version in [`.nvmrc`](.nvmrc) (run `nvm use`); Node 24.17.0+ currently breaks the accessibility check due to an upstream regression.
88
- [Python](https://www.python.org) 3.10+ (optional, for pre-commit hooks)
99

1010
## Local development

0 commit comments

Comments
 (0)