Conventional Commits
Use for every commit in this repo. No exceptions.
Format
<type>: <compact summary>
- <bullet> (only if summary alone insufficient)
- <bullet>
Rules
Conventional commit type prefix.
feat:,fix:,chore:,refactor:,docs:,build:,ci:,test:,perf:,style:,revert:. Lowercase, no space before colon.Summary line ≤ 72 chars. Imperative mood. No period. Describes the change — not the file.
Body is optional. Add bullets only when the summary alone doesn't convey the full change. If summary is enough → stop there. No body.
Bullets are compact. One change per bullet. No prose, no explanation, no rationale.
Added X,Removed Y,Changed Z to W.No
Co-authored-by, no trailers unless explicitly requested.Scope optional.
feat(admin): add health endpoint— scope in parens after type. Use workspace names frompnpm-workspace.yamlwhen a change targets a specific workspace.Multiple scopes use commas without spaces. Include every affected publishable workspace:
feat(klex,agent-admin-api): add route types. Do not use slashes, whitespace, or duplicate scopes.Public Admin API changes require
agent-admin-api. If a Klex change alters the generatedAdminApideclaration, include bothklexandagent-admin-api. Never use an empty release-trigger commit; put the scopes on the non-empty implementation or documentation commit so rebase merging preserves them. CI compares the generated declaration against the PR base and rejects a missing release scope.
Examples
Summary only — sufficient:
chore: remove LICENSE file
Multiple affected workspaces:
feat(klex,agent-admin-api): expose god session routes
Summary + bullets — summary alone insufficient:
feat(klex): add tslog logger and admin server
- Add logger factory with tslog v5
- Add AdminAPI module with Hono server on port 2706
- Add /v1/health endpoint
- Add graceful shutdown via SIGINT/SIGTERM
Too verbose — don't do this:
feat(klex): add tslog logger and admin server
This commit introduces a new logging system based on tslog v5
which provides structured logging with child loggers for each
module. We also add an AdminAPI class that encapsulates a Hono
server listening on port 2706 with a health check endpoint...