git-commit

1. Be specific: Describe exactly what changed
2. Be consistent: Follow conventional commit format
3. Be atomic: One logical change per commit
4. Be clear: Write for others (including future you)
5. Be complete: Include why and context when needed
6. Be conventional: Follow standard format for automation

```

():

1. Choose the commit type:

- feat: New user-facing functionality

- fix: Bug fix for users

- docs: Documentation only

- refactor: Code restructuring without behavior change

- perf: Performance improvement

- test: Adding/updating tests

- build: Dependency/build system changes

- ci: CI/CD configuration changes

- chore: Maintenance tasks

- style: Code formatting

- revert: Reverting previous commit

1. Write subject line (imperative mood, ≤50 chars):

```

✅ feat(auth): add OAuth2 authentication

✅ fix(api): resolve race condition in user updates

❌ feat: added some stuff

❌ fix: bug fix

```

1. Add body if needed (explain why, not just what):

- Required for breaking changes

- Recommended for complex changes

- Wrap lines at 72 characters

1. Include footer:

- Breaking changes: BREAKING CHANGE: description

- Issue references: Closes #123, Fixes #456

Simple feature:

```

feat(auth): add password reset endpoint

```

Bug fix with context:

```

fix(api): prevent null pointer in user preferences

User preferences API crashed when optional fields were null.

Added null checks and default values.

Closes #456

```

Breaking change:

```

feat(api)!: change response format to JSON:API spec

BREAKING CHANGE: API responses now follow JSON:API format.

Update client code to parse data from data key instead

of root level.

Closes #789

```

For detailed guidance, load these reference files as needed:

• [commit-types.md](references/commit-types.md): Complete list of commit types with examples
• [quick-reference.md](references/quick-reference.md): Decision trees and checklists
• [best-practices.md](references/best-practices.md): Atomic commits, meaningful messages, issue references
• [writing-guidelines.md](references/writing-guidelines.md): Subject line rules, scope selection, body formatting
• [common-scenarios.md](references/common-scenarios.md): Examples for typical development situations
• [common-mistakes-to-avoid.md](references/common-mistakes-to-avoid.md): Anti-patterns and how to fix them
• [team-conventions.md](references/team-conventions.md): Customizing conventions for teams
• [commit-message-structure.md](references/commit-message-structure.md): Detailed format specifications
• [commit-message-templates.md](references/commit-message-templates.md): Ready-to-use templates
• [commit-workflow.md](references/commit-workflow.md): Integration with git workflows
• [examples-by-project-type.md](references/examples-by-project-type.md): Examples for web apps, libraries, mobile, microservices
• [advanced-patterns.md](references/advanced-patterns.md): Complex scenarios and edge cases
• [commit-message-convention.md](references/commit-message-convention.md): Enforcement tools and configurations