Git Commit Workflow

What it does

This skill automates Git commit creation, guiding you through best practices for commit messages and staging. It enforces conventional commits (e.g., feat(scope): description) to ensure clarity and automation-friendliness. The skill also supports explicit staging workflows where files are staged individually, promoting visibility and control over changes being committed.

When to use it

• When you need help crafting clear and standardized commit messages.
• To ensure consistent adherence to conventional commits for project consistency.
• For projects requiring detailed tracking of code changes through well-structured commits.
• Before committing, to gather context like staged files, diff stats, and related open GitHub issues.

Key capabilities

• Conventional Commits: Enforces a standardized commit format (type(scope): description).
• Explicit Staging: Promotes staging individual files for clear visibility.
• Logical Grouping: Encourages grouping related changes into focused commits.
• Commit Message Best Practices: Provides guidance on writing concise, factual, and imperative commit messages with issue references.
• Pre-commit Context Gathering: Offers a script to gather context (status, staged files, diff stats, recent log) before committing, optionally including open GitHub issues for auto-linking.

Example prompts

• "Generate a conventional commit message for this feature."
• "Show me the best practices for writing a bug fix commit message."
• "Run the pre-commit context gathering script with issue matching."

Tips & gotchas

• This skill primarily focuses on commits to the main branch, and pushes to remote feature branches for pull requests. See the git-branch-pr-workflow skill for more information about that pattern.
• For advanced commit message formatting like co-authored-by lines or BREAKING CHANGE notes, refer to the git-commit-trailers skill.
• The pre-commit context gathering script requires the CLAUDE_PLUGIN_ROOT environment variable to be set.