commit

Generate conventional git commit messages from staged changes.

3|Updated Jul 17, 2024
One-click install
npx skills add https://github.com/Castrozan/.dotfiles --skill commit-castrozan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit
Source: https://github.com/Castrozan/.dotfiles/tree/main/agents/skills/commit
Command: npx skills add https://github.com/Castrozan/.dotfiles --skill commit-castrozan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps developers craft git commits that follow conventional formats, include meaningful descriptions, and provide analysis of changes to improve traceability and review quality.

Core Features & Use Cases

  • Conventional Commit Enforcement: Ensures messages adhere to a standardized structure (feat:, fix:, docs:, etc.) for consistent history.
  • Descriptive Messages & Change Analysis: Generates or suggests commit descriptions that summarize changes, rationale, and impact.
  • Workflow Integration: Guides the user through staging and committing, producing a clean, reusable history across projects.

Quick Start

Describe the changes you want to commit, and ask the skill to generate a conventional, descriptive commit message. For example: "Please generate a commit message for the latest staged changes following the conventional commits spec."

Frequently Asked Questions about commit

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

FAQPage Schema
How do I generate conventional commit messages for staged git changes?

To generate conventional commit messages, analyze your staged git changes to determine scope and impact, then enforce a standardized structure like feat: or fix: to yield meaningful descriptions for consistent version control history.

What is the conventional commits format and why use it for version control?

The conventional commits format standardizes git messages using prefixes like feat: and fix: to indicate change types. Using it improves traceability, ensures consistent history, and enhances code review quality across projects.

Can I use automated commit message generation for docs and config files?

Yes, automated commit message generation applies to any repository workflow including docs and config files. It analyzes staged changes to produce conventional, descriptive messages regardless of the file type.

What's the best way to write descriptive git commit messages with change analysis?

The best way to write descriptive git commit messages is to automate change analysis on staged files, determining scope and impact to generate summaries that include rationale and follow conventional formats.

Does integrating conventional commits into my workflow require manual message formatting?

No, integrating conventional commits does not require manual formatting. Automation enforces the standardized structure and guides you through staging and committing, producing a clean, reusable history automatically.

When do I need to enforce a conventional structure for git commits?

You need to enforce a conventional structure for git commits when you want to improve traceability and review quality across projects, ensuring that all changes adhere to a standardized format for consistent history.