From 692ddaebb0784c36be2c0062ecfd80790533ff6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kr=C3=A6n=20Hansen?= Date: Sat, 31 Oct 2026 11:46:55 +0100 Subject: [PATCH 1/2] docs: add contributing guidelines Co-Authored-By: Claude Opus 5.5 (1M context) --- CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..6c6432a9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# Contributing + +## Setup + +You'll need Node.js 24 (pinned in [`.nvmrc`](.nvmrc)) and pnpm, which Corepack provides: + +```bash +nvm install && nvm use +corepack enable +pnpm install +``` + +Then build, picking one of: + +```bash +pnpm run build # TypeScript only: enough for most work on the Node.js tooling +pnpm run bootstrap # Also builds native artifacts: needs the Android NDK and/or Apple toolchains, and takes a while +``` + +Use `pnpm run dev` to rebuild TypeScript on change. + +## Before opening a pull request + +```bash +pnpm --filter weak-node-api run prebuild:prepare # Generates sources that linting needs +pnpm run lint +pnpm run prettier:check +pnpm run depcheck +pnpm test +``` + +`pnpm test` needs a prior `pnpm run bootstrap`. While iterating, run a single package's tests instead, for example `pnpm --filter cmake-rn run test`. + +If your change affects a published package, add a changeset with `pnpm changeset`. + +## Pull requests + +Some CI jobs only run when the pull request has a matching label (`Host 🏡`, `Apple 🍎`, `Android 🤖`, `MacOS 💻`, `Ferric 🦀` or `weak-node-api`). Labels added after a pull request is opened take effect on the next push. + +Learn more about the project in the [README](README.md#packages) and in ["how it works"](docs/HOW-IT-WORKS.md). From 1e06587313744b512bbf9e8ad2ac8c94bd7340e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kr=C3=A6n=20Hansen?= Date: Sat, 31 Oct 2026 11:52:41 +0100 Subject: [PATCH 2/2] docs: defer to .nvmrc for the Node.js version Co-Authored-By: Claude Opus 5.5 (1M context) --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6c6432a9..d006be27 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ ## Setup -You'll need Node.js 24 (pinned in [`.nvmrc`](.nvmrc)) and pnpm, which Corepack provides: +You'll need the Node.js version pinned in [`.nvmrc`](.nvmrc) and pnpm, which Corepack provides: ```bash nvm install && nvm use