Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 1.65 KB

File metadata and controls

38 lines (25 loc) · 1.65 KB

Contributing

Development

bun install
bun run check

bun run check runs typecheck, lint, format check and unit tests. bun run format rewrites the tree.

Contributors sign the CLA on their first PR; the CLA bot explains how.

bun run test:e2e needs a Postgres 13+ role with CREATEDB in DATABASE_URL, e.g. DATABASE_URL=postgres://localhost:5432/postgres bun run test:e2e. Each suite creates and drops its own database, and suites skip when DATABASE_URL is unset.

Migrations

migrations/*.sql ship in the tarball and all run on every boot; there is no ledger. Every statement must be idempotent (IF NOT EXISTS, ADD COLUMN IF NOT EXISTS). "public". references are rewritten to the host's schema.

Commit messages

Commit subjects and PR titles follow Conventional Commits: feat, fix, refactor, test, docs, build, ci, perf, and chore(release): x.y.z for releases. Add ! only for public API breaks: removed or renamed exports, changed signatures, newly required params. Peer and dependency range changes are build(deps): with no !. Keep subjects imperative, lowercase after the colon, 72 characters or less, and free of ticket IDs. Every PR links its issue with a Closes <issue id> line in the PR body.

Releasing

Releases are manual. On a clean, up-to-date main:

npm version <patch|minor> -m "chore(release): %s"
git push --follow-tags
gh release create "v$(node -p 'require("./package.json").version')" --generate-notes
npm publish

Bump minor only for breaking API changes; everything else is a patch. prepack builds dist/ from the tagged commit.