Skip to content

Git Conventions ​

Commit Format ​

<type>(<scope>): <description>

One commit = one clear, revertable objective. No emoji prefix.

Allowed Types ​

TypeUsage
featNew feature
fixBug fix
docsDocumentation only
refactorRefactoring without behavior change
testAdding or fixing tests
ciCI/CD changes
buildBuild / dependency changes
choreMaintenance tasks

Allowed Scopes ​

main · renderer · preload · shared · ws · overlays · khinsider · timer · discord · security · perf · docs

Valid Examples ​

feat(renderer): add quick reconnect status badge
fix(ws): guard malformed overlay payload
refactor(main): split twitch auth callback helper
docs(docs): align agent commit rules
fix(security): bind oauth callback to 127.0.0.1 explicitly
chore(build): update electron to 35.x

Pre-commit Checklist ​

bash
pnpm typecheck   # must pass without error
pnpm lint        # must pass without error
pnpm build       # must compile without error

Rules ​

  • Do not mix unrelated topics in the same commit
  • Description in English (international community)
  • Title length: 72 characters max

Released under the MIT License.