Conventional Commits

This skill provides comprehensive guidance on writing conventional commit messages for the uspark project. All commits must follow the Conventional Commits format to ensure consistent history and enable automated versioning via release-please.

Quick Reference

Format

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Core Rules (STRICT REQUIREMENTS)

1. Type must be lowercase - feat: not Feat: or FEAT:
2. Description must start with lowercase - add feature not Add feature
3. No period at the end - fix user login not fix user login.
4. Keep title under 100 characters - Be concise
5. Use imperative mood - add not added or adds

Common Types (Quick List)

| Type | Purpose | Release? | |------|---------|----------| | feat: | New feature | ✅ Minor bump | | fix: | Bug fix | ✅ Patch bump | | docs: | Documentation | ❌ No release | | refactor: | Code refactoring | ❌ No release | | test: | Tests | ❌ No release | | chore: | Build/tools | ❌ No release |

Pro tip: If you want a refactor to trigger a release, use fix: refactor ... instead.

When to Load Additional Context

• Need detailed type definitions? → Read types.md
• Confused about what triggers releases? → Read release-triggers.md
• Want to see good and bad examples? → Read examples.md

Quick Validation Checklist

Before committing, verify:

• ✅ Type is lowercase and valid
• ✅ Description starts with lowercase
• ✅ No period at the end
• ✅ Under 100 characters
• ✅ Imperative mood (add, fix, update)
• ✅ Accurately describes the "why" not just the "what"

Common Mistakes to Avoid

❌ Fix: Resolve database connection timeout. (capitalized type, has period) ❌ added user auth (missing type, wrong tense) ❌ feat: Add user authentication system with OAuth2... (capitalized description, too long)

✅ fix: resolve database connection timeout ✅ feat: add user authentication ✅ docs(api): update endpoint documentation

Integration with Workflow

This skill should be triggered whenever:

1. Creating a commit message
2. Validating an existing commit message
3. Planning what changes should go into a single commit
4. Deciding if changes should trigger a release

The commit message should focus on why the change was made, not what was changed (git diff shows the what).