コンテンツにスキップ

Commit message guidelines

Qubex prefers Conventional Commits style prefixes.

Format

Use:

<type>: <summary>

Examples:

  • feat: add GHZ sequence helper for linear topology
  • fix: handle empty entangle steps in contrib helper
  • docs: clarify local quality gate commands
  • test: add regression test for state tomography output shape
  • feat for new user-facing behavior.
  • fix for bug fixes.
  • docs for documentation-only changes.
  • refactor for internal changes without behavior change.
  • test for test additions/updates.
  • chore for maintenance tasks.

Good commit messages

  • Use imperative mood.
  • Keep summary concise and specific.
  • Split unrelated changes into separate commits.