Contributing

The full guide is CONTRIBUTING.md.

Setup

Requirements: Node.js 24 (22.18 or later works) and pnpm 12.


git clone https://github.com/vialabs-net/quickben.git
cd quickben
corepack enable
pnpm install
pnpm lint typecheck test build

Command	What it does
`pnpm build`	Build every package and this site.
`pnpm lint`	ESLint: typescript-eslint, sonarjs, import order.
`pnpm typecheck`	`tsc` in every package, including type tests and docs samples.
`pnpm test`	Vitest in every package.
`pnpm test:coverage`	Tests with coverage. Fails under 85 % lines.
`pnpm format`	Prettier.
`pnpm changeset`	Describe a change for the changelog.

Run one package with pnpm --filter @quickben/core test.

Rule	Detail
Branch	From `trunk`. Keep pull requests small.
Commits	Conventional Commits : `feat(core): …`, `fix(db-memory): …`, `docs: …`.
Changesets	Add one when a published package changes.
CI	Lint, typecheck, tests with coverage, build and the SonarCloud quality gate must pass.

The site is apps/docs (Nextra). Pages are MDX files in apps/docs/content.

Command	What it does
`pnpm --filter docs dev`	Run the site on http://localhost:3000 .
`pnpm --filter docs typecheck`	Extract every `ts` code block and typecheck it.
`pnpm turbo build --filter=docs`	Build the site and its dependencies.

Code blocks are checked against the workspace packages. Mark a block nocheck only for signatures and third-party APIs.