conventional-commits

Validate commit messages against the Conventional Commits specification.

1|Updated Jun 20, 2022
One-click install
npx skills add https://github.com/avvale/aurora-front --skill conventional-commits-avvale
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: conventional-commits
Source: https://github.com/avvale/aurora-front/tree/main/.claude/skills/conventional-commits
Command: npx skills add https://github.com/avvale/aurora-front --skill conventional-commits-avvale

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures all commits follow the Conventional Commits specification, improving changelog generation, release planning, and history readability for Aurora projects.

Core Features & Use Cases

  • Commit Message Validation: verify messages match the <type>(<scope>): <subject> pattern and allowed types (feat, fix, docs, style, refactor, test, chore, build, ci, perf, revert, etc.).
  • Automated Guidance: suggest corrections and enforce subject length and formatting rules.
  • Integration Points: hook into git hooks or CI to block non-conforming commits and to generate changelogs.

Quick Start

Format your commit messages as <type>(<scope>): <subject> and use one line per commit. Example: feat(auth): add login rate limiting

Frequently Asked Questions about conventional-commits

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce conventional commit messages in git?

Enforce conventional commit messages by validating the <type>(<scope>): <subject> pattern during commit creation. This verifies allowed types like feat, fix, and docs, and can integrate with git hooks or CI to block non-conforming commits.

What are the allowed commit types for conventional commits?

Allowed conventional commit types include feat, fix, docs, style, refactor, test, chore, build, ci, perf, and revert. The validation checks the message format against these specific types to ensure structured git history.

Can I use conventional commits to generate changelogs in CI?

Use conventional commits in CI to generate changelogs and improve release planning. The structured <type>(<scope>): <subject> format allows automated changelog generation by hooking the validation into your CI pipeline.

How do I fix invalid conventional commit formatting?

Fix invalid conventional commit formatting by following automated guidance suggestions. The validation enforces subject length and formatting rules, prompting corrections to ensure the message matches the required <type>(<scope>): <subject> pattern.

Why enforce structured commit messages for code review?

Enforce structured commit messages for code review to improve git history readability and automate changelog generation. Validating the conventional commits specification ensures consistent type, scope, and subject formatting across all project commits.