Release and commit workflow

July 8, 2026 · View on GitHub

The mechanics every change goes through before it lands. These are procedures — follow them in order.

Changesets

  • Every feature or fix needs a changeset. Run npx changeset (or npx changeset --empty to fill it in by hand) and describe the change in sentence case.
  • Bumping one package bumps the others too, so list inside the changeset only the packages whose behavior changed for the end user. Follow semver.
  • Write a precise, user-friendly message. If a change can break a user's existing flow, add a short Note.
  • Before writing the message, read the appropriate package CHANGELOG.md to match the existing entry structure.
  • Skip the changeset only for changes that don't affect the published packages — for example, edits to these AI-instruction files or repository tooling.

Commits

  • Ask before committing — let the contributor make the commit. Don't execute Git write operations without explicit user confirmation.
  • Before committing, run npm run lint and make sure the tests and npm run typecheck pass.
  • Use one meaningful sentence that follows Conventional Commits.
  • Don't add AI co-author or "Generated by" lines.
  • Don't modify the pull request template.