Skip to content

Releasing ​

Changelog ​

CHANGELOG.md at the repo root records what changed in the running software, newest first, grouped by release and following Keep a Changelog: Added, Changed, Fixed, Removed, Migrations. Each entry names the spec version it was built against. The spec has its own changelog; do not mix them.

While the product is pre-launch, releases are dated (2026-11-18) rather than semver-numbered, and the first tagged version will be 0.1.0 when step 1 is complete. Afterwards:

BumpWhen
PatchBug fix, no schema or API change
MinorNew feature, additive schema or API change
MajorBreaking API (v2 introduced) or a data migration that cannot be rolled forward trivially

Before a release ​

  1. bun run check-types && bun run test && bun run lint && bun run format:check
  2. MIGRATION_BASE=origin/main bun run db:check
  3. bun run ui:status has no surprises (unreviewed local edits)
  4. Changelog updated; SPEC_VERSION matches the spec changelog's newest entry
  5. Open decisions with a changed answer are reflected in settings

Commits and pull requests ​

  • One logical change per commit, imperative subject ("Add settings registry"). Conventional prefixes (feat:, fix:, docs:, chore:) are welcome but not enforced.
  • A pull request states: what changed, which spec chapter(s), whether a migration is included, whether v1 of the API changed, and how it was verified. The template in .github/pull_request_template.md lists these.

CI ​

.github/workflows/ci.yml runs on every pull request: install, type-check, lint, format check, tests, migration append-only check against the base branch, and the docs build. A failing migration check means an applied migration was edited: fix forward.

Internal documentation. Not for clients.