Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (35 loc) · 1010 Bytes

CONTRIBUTING.md

File metadata and controls

52 lines (35 loc) · 1010 Bytes
Raw

Contributing

Setup

Use nvm to manage Node versions. CI runs on Node 20; anything >= 18 works.

nvm install 20
nvm use 20

This repo uses Yarn (Berry, via .yarnrc.yml). Install dependencies:

yarn

Development

Generated GraphQL clients live in generated/. Codegen also regenerates src/types.ts with runtime exports for every generated enum. Regenerate them after changing queries or the schema:

yarn gen-clients

Build both CJS and ESM outputs:

yarn build

Testing and linting

yarn test        # vitest, watch mode
yarn test:ci     # single run
yarn lint
yarn typecheck

To refresh the schema used by tests, run yarn update-test-schema.

Docs

yarn gen-docs
yarn start-docs

Releasing

Publishing is handled by GitHub Actions (.github/workflows/publish.yml). Bump the version with yarn version, which also regenerates generated/version.ts via the postversion hook.