Commit Messages

Recommended commit message format for HeadlessX and companion docs work.

by @saifyxpro

Recommended format

Use:

Examples:

Common scopes

  • api
  • web
  • yt-engine
  • infra
  • docs
  • mcp

Good commit traits

  • one clear change per commit
  • scope matches the part of the system touched
  • summary explains behavior, not just files

Avoid

  • fix stuff
  • update files
  • mixing refactors, features, and docs with no clear boundary

When docs deserve their own commit

Make a separate docs commit when:

  • routes changed
  • environment requirements changed
  • setup instructions changed
  • dashboard UX changes alter operator workflows