git-commit

Generate Git commit messages from staged changes with convention enforcement.

Updated Sep 12, 2023
One-click install
npx skills add https://github.com/byunghak-dable/.dotfiles --skill git-commit-byunghak-dable
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: git-commit
Source: https://github.com/byunghak-dable/.dotfiles/tree/main/claude/.claude/skills/git-commit
Command: npx skills add https://github.com/byunghak-dable/.dotfiles --skill git-commit-byunghak-dable

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of Git commits, ensuring adherence to project-specific conventions and best practices for clear, maintainable commit history.

Core Features & Use Cases

  • Convention Enforcement: Automatically applies project commit message formats (type, scope, description).
  • Interest-Based Committing: Groups changes by logical interest, creating separate commits for each.
  • Staged Diff Review: Provides a review of staged changes before committing, highlighting potential issues.
  • Use Case: When you've made multiple unrelated changes, this skill helps you separate them into atomic commits like feature: implement user authentication and fix: resolve login bug.

Quick Start

Use the git-commit skill to create a commit for your staged changes.

Frequently Asked Questions about git-commit

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

FAQPage Schema
How do I automate git commit message generation based on staged changes?

Automating git commit message generation analyzes your staged changes and applies project conventions to create structured commit types, scopes, and descriptions for a clean history.

What is interest-based separation when creating git commits?

Interest-based separation for git commits groups staged changes by logical interest, creating separate atomic commits for each distinct feature or fix to maintain a clean history.

How can I review staged diffs before finalizing a git commit?

Reviewing staged diffs before a git commit highlights potential issues in your changes and provides optional user confirmation to ensure commit content accuracy.

Can I enforce project commit conventions like type and scope automatically?

Enforcing project commit conventions automatically applies specific commit message formats, ensuring adherence to required types, scopes, and descriptions for maintainable version control.

What is the best way to group unrelated changes into atomic git commits?

The best way to group unrelated changes into atomic git commits is using interest-based separation, which creates distinct commits for each logical change.