conventional-commits

ffMathy's avatarfrom ffMathy

Commit message standards following Conventional Commits specification. Use this when writing commit messages for the Hey Jarvis project.

⭐2stars🔀0forks📁View on GitHub🕐Updated Jan 10, 2026

When & Why to Use This Skill

This Claude skill provides a comprehensive framework for writing standardized commit messages following the Conventional Commits specification. It helps developers maintain a clean, readable, and machine-parseable git history by enforcing specific types, scopes, and formatting rules, which is essential for professional version control and team collaboration.

Use Cases

  • Standardizing Version Control: Use this skill to ensure all team members follow the same commit format, making the project history easy to audit, search, and navigate.
  • Automated Changelog Generation: Leverage structured commit types (like feat and fix) to automatically generate release notes and documentation for new software versions.
  • Semantic Versioning Management: Identify breaking changes and feature updates through commit prefixes to automatically determine the appropriate semantic version (SemVer) increments.
  • Improving Code Review Efficiency: Provide reviewers with immediate clarity on the intent and scope of changes through well-formatted subject lines and detailed commit bodies.
  • CI/CD Integration: Ensure that all commits and pull request titles meet the structural requirements needed for automated deployment pipelines and validation scripts.
nameconventional-commits
descriptionCommit message standards following Conventional Commits specification. Use this when writing commit messages for the Hey Jarvis project.

Conventional Commits Standards

CRITICAL: ALWAYS follow Conventional Commits format

Format

<type>(<scope>): <subject>

<body>

<footer>

Types

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation only
  • style: Formatting (no code change)
  • refactor: Code change (no bug fix or feature)
  • perf: Performance improvement
  • test: Adding/refactoring tests
  • chore: Maintenance tasks
  • build: Build system changes
  • ci: CI configuration changes

Scopes

Use project-specific scopes:

Root level:

  • deps, config, ci, build

MCP project:

  • mcp, agents, workflows, tools
  • weather, shopping, cooking, coding

Other projects:

  • addon, firmware, elevenlabs

Examples

feat(mcp): add calendar agent for scheduling
fix(shopping): correct product quantity calculation
docs(agents): update workflow examples
feat(api)!: change authentication method

BREAKING CHANGE: Auth now requires API key

Subject Line Rules

  • Keep under 72 characters
  • Use imperative mood ("add" not "added")
  • Don't capitalize first letter
  • No period at end
  • Reference issues in footer: Closes #123

Breaking Changes

Add ! before colon for breaking changes:

feat(api)!: change authentication method

BREAKING CHANGE: Auth now requires API key instead of username/password

Pull Request Titles

PR titles must also follow Conventional Commits format:

feat(mcp): add calendar agent for scheduling
fix(shopping): correct product quantity calculation

Multi-line Commits

For commits with multiple changes:

feat(mcp): add calendar agent

- Implement Google Calendar integration
- Add recurring event support
- Include timezone handling

Closes #123

Scopes by Project

MCP:

feat(agents): add new agent
feat(weather): add forecast tool
fix(workflows): correct state handling

Home Assistant Addon:

feat(addon): add configuration option
fix(config): correct port mapping

ElevenLabs:

feat(voice): add new personality trait
test(elevenlabs): add conversation tests

What NOT to Do

❌ Don't use vague subjects like "fix bug" or "update code" ❌ Don't capitalize subject line ❌ Don't end subject with period ❌ Don't mix multiple types in one commit ❌ Don't forget scope when applicable ❌ Don't exceed 72 characters in subject

Why This Matters

  • Automated changelog generation: Tools parse commits for releases
  • Clear history: Easy to understand what changed
  • Semantic versioning: Types indicate version bumps
  • Searchability: Easy to find specific changes