Skip to content

Development

github-actions[bot] edited this page Nov 21, 2026 · 1 revision

Development

Node from .nvmrc, pnpm from packageManager in package.json.

pnpm install
pnpm verify   # Biome, types, tests, build: run before calling work done
pnpm check    # Biome only; `pnpm fix` writes its fixes

Rules

  • The contract comes first: a helper only wraps what Spotcraft's docs/contracts.md already says.
  • The client entry (src/client.ts) has no Node APIs and no dependencies.
  • A user-facing change goes under Unreleased in the changelog, and the guide changes with it.
  • Branches, commits and pull requests follow the ecosystem's AGENTS.md.

Releasing

  1. On a chore/release-X.Y.Z branch from origin/main, set version in package.json, and in CHANGELOG.md rename Unreleased to the version and date. Open a pull request into main and merge it once the checks pass.
  2. Tag the merge commit, signed, and push the tag: git fetch origin && git tag -s vX.Y.Z 'origin/main^{commit}' -m vX.Y.Z && git push origin vX.Y.Z.
  3. CI verifies the tagged commit, then publishes to npm with trusted publishing and provenance (scripts/npm-publish.sh): latest, or next for a pre-release. A version already on npm is skipped, so a failed run can be re-run.
  4. Publish a GitHub Release for the tag with its changelog section.

Clone this wiki locally