Home
Project

Contributing

Set up koota-kit, validate a change, and contribute through the protected workflow.

Local workflow

mise install
pnpm install --frozen-lockfile
pnpm verify
pnpm docs:build

pnpm verify is the library gate: Biome, Markdown linting, strict TypeScript, 100% coverage, dual-format builds, runnable examples, package validation, and a clean-consumer runtime check. pnpm docs:build validates and renders the Sourcey site.

Branch from main, make a focused Conventional Commit, open an upstream pull request, and keep the branch current by merging main into it when necessary. The protected path uses automated checks rather than a routine human approval; merge commits preserve the constituent history. Do not hand-edit versions or CHANGELOG.md: Release Please owns them.

Read the repository contribution guide and agent instructions before changing public APIs.