commit-messages

Generate conventional commit messages from staged Git changes.

340|18|Updated May 11, 2023
One-click install
npx skills add https://github.com/khaneliman/khanelinix --skill commit-messages-khaneliman
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit-messages
Source: https://github.com/khaneliman/khanelinix/tree/main/modules/common/ai-tools/skills/commit-messages
Command: npx skills add https://github.com/khaneliman/khanelinix --skill commit-messages-khaneliman

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates conventional commit messages based on staged changes, promoting consistency and readability in version history.

Core Features & Use Cases

  • Conventional format guidance: outputs commits in the standard <type>(<scope>): <subject> structure.
  • Path-Based / Scoped formats: supports path-based scopes for monorepos or large repos.
  • Guided decision logic: analyzes changes to suggest appropriate types (feat, fix, docs, etc.) and scopes.

Quick Start

Generate a conventional commit message for the currently staged changes.

Frequently Asked Questions about commit-messages

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

FAQPage Schema
How do I generate conventional commit messages from staged Git changes?

Conventional commit messages are generated by analyzing your staged Git changes to automatically suggest the type, optional scope, and subject. This enforces the standard format and improves version history consistency without manual formatting.

What is the conventional commit format and when do I need scopes?

The conventional commit format uses a <type>(<scope>): <subject> structure to standardize Git history. Scopes are optional context tags used to improve traceability, which are especially useful for grouping changes in monorepos or large repositories.

Can conventional commits work with monorepos and path-based scopes?

Yes, conventional commits support path-based scopes for monorepos and large repositories. By analyzing staged changes, the appropriate type and path-based scope are suggested, ensuring traceability across multiple project components within a single repository.

How do I choose the right commit type like feat or fix for my changes?

Choosing the right commit type is automated by analyzing your staged changes to suggest types like feat, fix, or docs. This guided decision logic ensures your Git history accurately reflects the nature of each modification.

What is the best way to enforce consistent Git commit messages?

The best way to enforce consistent Git commit messages is to automate generation from staged changes using conventional formats. This eliminates manual formatting errors and standardizes types and scopes across everyday Git workflows.

Do I need any dependencies to automate conventional commit generation?

No dependencies are required to automate conventional commit generation. The process works directly with your staged Git changes to suggest the appropriate types and scopes, integrating seamlessly into existing everyday Git workflows.