Skip to content

commit-conventions.md

Latest commit

 

History

History
63 lines (46 loc) · 1.61 KB

commit-conventions.md

File metadata and controls

63 lines (46 loc) · 1.61 KB
Raw

Commit Conventions

Format

<type>: <description> (#issue)

First line under 72 characters. Focus on why, not what.

Types

Type When
feat New feature
fix Bug fix
docs Documentation only
test Adding or updating tests
refactor Code change that doesn't add a feature or fix a bug
chore Build, deps, config, CI changes

Examples

feat: Add user search with fuzzy matching (#42)
fix: Prevent duplicate form submissions (#15)
docs: Update API authentication guide
test: Add integration tests for checkout flow (#30)
refactor: Extract scoring logic into pure functions
chore: Upgrade Next.js to v15

Rules

  1. First line under 72 characters — this is the subject line
  2. Imperative mood — "Add feature" not "Added feature"
  3. Reference issues — append (#XX) when applicable
  4. No period at the end of the subject line
  5. Body is optional — separate from subject with a blank line

Extended Commit (Optional Body)

For commits that need more explanation:

fix: Prevent negative handicaps from breaking match play (#88)

Math.floor was truncating toward negative infinity, causing -0.7 to
become -1 instead of 0. Switched to Math.trunc which truncates toward
zero. Also clamp ESC lookup to minimum of 0.

Project-Specific Prefixes

Some projects use component prefixes for additional context:

[Auth] Add Google SSO provider
[DB] Create rounds and round_scores tables
[Scorecard] Implement score input with auto-totals

These are optional and project-specific — the <type>: prefix is always required.