Commit Message Conventions

Format

Use the following format:

<type>(<optional scope>): <short summary>

Examples:

• •feat(auth): add MFA to login flow
• •fix(api): handle null payloads in /v2/orders
• •chore(ci): speed up test pipeline

Types

• •feat – new user-facing feature
• •fix – bug fix
• •refactor – structural code changes without behavior change
• •chore – tooling, CI, non-runtime code
• •docs – documentation-only changes
• •perf – performance improvements
• •test – adding or adjusting tests

Body

• •Use when additional explanation is necessary.
• •Include:
  • •Motivation for the change
  • •Notable design decisions
  • •Links to tickets or issues

Footer

• •Include breaking change notes:
  • •BREAKING CHANGE: [description]
• •Include issue references:
  • •Fixes #1234