commit

Analyze code changes and generate structured commit sequences.

1|Updated Dec 30, 2024
One-click install
npx skills add https://github.com/FarzamMohammadi/dev-toolbox --skill commit-farzammohammadi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit
Source: https://github.com/FarzamMohammadi/dev-toolbox/tree/main/ai/claude-code/skills/commit
Command: npx skills add https://github.com/FarzamMohammadi/dev-toolbox --skill commit-farzammohammadi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill guides developers to transform code changes into a sequence of clear, descriptive commits, reducing ambiguity and improving project history.

Core Features & Use Cases

  • Grouping: Analyze changes and partition them into logical commit packages according to feature, directory, or logical changes.
  • Commit Sequencing: Arrange commits to form a coherent narrative, with an enabling commit first when needed.
  • Output Structure: Provide a highest-level title, a middle-level description, and included context for the changes to be committed.

Quick Start

Provide the patch or diff output from your working directory to the skill, and it will generate a commit plan with suggested commit titles, descriptions, and ordering.

Frequently Asked Questions about commit

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

FAQPage Schema
How do I group multiple file changes into a logical git commit sequence?

To group changes into a logical git commit sequence, provide your working directory diff to a tool that analyzes changes and partitions them into coherent commit packages by feature, directory, or logical change, ensuring a structured narrative.

What's the best way to write descriptive git commit messages for multi-file features?

The best way to write descriptive git commit messages is to enforce a hierarchical structure with a highest-level title, a middle-level description, and detailed diff focus context, reducing ambiguity and improving project history for multi-file features.

Can I organize my code changes by feature before committing them to version control?

Yes, you can organize code changes by feature before committing to version control by analyzing the patch output and partitioning the files into logical commit packages based on feature, directory, or logical change boundaries.

How do I create a coherent commit history from a large uncommitted diff?

To create a coherent commit history from a large diff, analyze the changes and arrange them into a commit sequence that forms a narrative, placing enabling commits first when needed to guide the structured progression.

What structure should I use for a descriptive commit message on a complex branch?

A descriptive commit message on a complex branch should use a hierarchical structure containing a highest-level title, a middle-length description, and a detailed diff focus to provide clear context for the changes being committed.