Repository navigation
Development
github-actions[bot] edited this page Nov 21, 2026
·
1 revision
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-
The contract comes first: a helper only wraps what Spotcraft's
docs/contracts.mdalready says. -
The client entry (
src/client.ts) has no Node APIs and no dependencies. - A user-facing change goes under
Unreleasedin the changelog, and the guide changes with it. - Branches, commits and pull requests follow the ecosystem's AGENTS.md.
- On a
chore/release-X.Y.Zbranch fromorigin/main, setversioninpackage.json, and inCHANGELOG.mdrenameUnreleasedto the version and date. Open a pull request intomainand merge it once the checks pass. - 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. - CI verifies the tagged commit, then publishes to npm with trusted publishing and provenance
(
scripts/npm-publish.sh):latest, ornextfor a pre-release. A version already on npm is skipped, so a failed run can be re-run. - Publish a GitHub Release for the tag with its changelog section.
Published from docs/. Edit the files there; changes here are overwritten.