conventional-commit

Analyze staged git changes and generate Conventional Commits messages.

7|Updated Dec 5, 2023

Search Tags:#automation #git #staging #scope #commit-message #conventional-commit

Ready to run

npx skills add https://github.com/mParticle/aquarium --skill conventional-commit-mparticle

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: conventional-commit
Source: https://github.com/mParticle/aquarium/tree/main/.claude/skills/conventional-commit
Command: npx skills add https://github.com/mParticle/aquarium --skill conventional-commit-mparticle

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Conventional commits provide a standardized history structure, making it easier to understand changes and automate release notes. This skill helps ensure every commit message adheres to the Conventional Commits spec, improving traceability and tooling compatibility.

Core Features & Use Cases

Analyze staged changes to determine the correct type (feat, fix, docs, etc.) and infer a scoped area from touched files.
Enforce the format type(scope): description and suggest atomic, descriptive messages for each change.
Promote best practices in collaborative projects by guiding small, well-scoped commits (typically 1-3 files per commit) and appending a #agentic footer when required.

Quick Start

Stage your changes and run the conventional-commit tool to generate a compliant conventional commit message.

Frequently Asked Questions about conventional-commit

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

FAQPage Schema

How do I generate a conventional commit message from staged git changes?▼

To generate a conventional commit message, stage your git changes and run the tool. It analyzes the staged files to output a compliant message with the correct type, inferred scope, and description.

What is the conventional commit format for type, scope, and description?▼

The conventional commit format structures messages as type(scope): description. This skill enforces this structure by determining the type and inferring the scoped area from the touched files in your staged changes.

How do I enforce atomic and well-scoped commits in a collaborative project?▼

To enforce atomic commits in a collaborative project, this skill guides you to stage small, focused changes, typically 1-3 files per commit, and generates descriptive conventional commit messages for each change.

Does this conventional commit generator work with any git repository?▼

Yes, this conventional commit generator works with any git repository. It requires no external dependencies and analyzes your staged changes to produce compliant commit messages suitable for collaborative projects.

Why should I use conventional commits for my project history?▼

You should use conventional commits to provide a standardized history structure. This makes it easier to understand changes, improves traceability, and ensures compatibility with release notes automation tooling.

Can I append specific footers like #agentic to my conventional commit messages?▼

Yes, you can append specific footers like #agentic to your conventional commit messages. The skill supports appending required footers while ensuring the message conforms to the standard conventional commits spec.