git-commit-assistant_skill

Overview

This skill generates clear, conventional git commit messages and, with your approval, runs the commit for staged changes. It enforces a quality gate so commits stay focused, descriptive, and machine-readable. Use it to draft, improve, or apply commits while avoiding noisy or mixed-history commits.

How this skill works

The skill inspects the staged diff and git status to determine what will be committed and whether changes represent a single concern. It proposes an imperative-summary, optional scope, body, and footers following conventional commit rules, presents the full message for approval, and only runs git commit after you confirm. If the commit fails or unstaged changes exist, it reports details and awaits further instructions.

When to use it

• Draft a concise conventional commit for staged work.
• Validate that staged changes match the intended commit intent and scope.
• Split or refuse commits that mix formatting/noise with functional changes.
• Run a vetted commit after reviewing the suggested message.
• Enforce consistent commit formatting across a team or CI workflow.

Best practices

• Stage only related changes; keep each commit to a single concern.
• Write a 50–72 character imperative summary without a trailing period.
• Include a short optional scope like api, auth, or deps when helpful.
• Add a body only for rationale, decisions, and trade-offs; wrap lines ~72 chars.
• Use footers for breaking changes and issue references (e.g., Closes #123).

Example use cases

• You have staged code fixing an auth bug and want a well-formed commit message before committing.
• A teammate submitted a mixed diff; use the assistant to detect and advise splitting concerns.
• Prepare release commits with clear breaking-change footers and issue links for changelogs.
• Automate message drafting in a pre-commit workflow while requiring human approval to commit.