Git Conventional Commits

What it does

This skill enables AI agents to generate Git commit messages that adhere to the Conventional Commits specification. It ensures consistent and machine-readable commit history, facilitating automated versioning and release management. The agent can analyze changes and produce formatted commit messages including type (feat, fix, docs, etc.), scope, and description.

When to use it

• Automating repetitive tasks: Generate standardized commit messages for small code changes or bug fixes.
• Improving team consistency: Enforce a consistent commit message style across a development team.
• Streamlining release processes: Leverage Conventional Commits to automate semantic versioning and changelog generation.
• Analyzing project history: Easily understand the purpose and scope of commits through standardized messages.

Key capabilities

• Generates Conventional Commit messages based on provided change descriptions.
• Supports various commit types (feat, fix, docs, style, refactor, perf, test, chore).
• Formats commit messages with type, scope, and description components.

Example prompts

• "Generate a conventional commit message for this bug fix: 'Fixed issue where the button text was truncated.'"
• "Create a commit message of type 'feat' describing these changes: 'Added user authentication functionality.'"
• “Write a conventional commit to document refactoring of the database connection logic.”

Tips & gotchas

• Ensure the AI agent has access to information about the code changes being committed. A detailed description of the modifications is crucial for accurate message generation.