Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/repo-standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,8 @@ Use only GitHub's default labels and labels added by Dependabot.
- JavaScript and TypeScript lint with oxlint and format with oxfmt, replacing ESLint and Prettier. Commit `.oxlintrc.json` with warnings denied and `.oxfmtrc.json`. `format:check` runs in the `lint` job. Keep Prettier only for a file type oxfmt can't format yet, named in `AGENTS.md`.
- TypeScript repos have a `typecheck` script: `tsc --noEmit` in strict mode, or `astro check` plus `tsc -p tsconfig.tests.json --noEmit` in Astro sites.
- Unit tests use Vitest; `node:test` is fine in repos with no dependencies. End-to-end tests use Playwright. A repo with no tests yet has a smoke test: the build works and one file loads.
- Node is 24 or newer. `.nvmrc` pins the major (like `24`), and `engines.node`, if set, is a `>=` floor on that major. `actions/setup-node` reads `.nvmrc`, sets `check-latest: true` so CI gets patch releases the runner image hasn't cached yet, and caches npm.
- Node is 24 or newer. `.nvmrc` pins major.minor (like `24.22`) and patch releases float; `engines.node`, if set, is a `>=` floor on that major. `actions/setup-node` reads `.nvmrc`, sets `check-latest: true` so CI gets patch releases the runner image hasn't cached yet, and caches npm.
- Every runtime version file carries major.minor, never a bare major or an exact patch: `.nvmrc`, `.node-version`, `.python-version`, `.go-version`, the Swift tools version. Nothing updates these files by itself (Dependabot has no ecosystem for them), so move the minor by hand when a new one is out, in every repository on that line together.
- Renaming a workflow: required checks match job names, not workflow names, so only update what listens for the old workflow name (`workflow_run` triggers, docs), in the same pull request.
- Renaming a job that a ruleset requires takes two pull requests, because a required check that stops reporting blocks every pull request with "Waiting for status to be reported":
1. Keep the old job and add the renamed one beside it, with anything that listens for it accepting both names. Merge.
Expand Down