AgentSkillsCN

commit-messages

撰写清晰的提交信息。当您被要求提交更改、撰写提交信息、准备提交，或为版本控制描述更改时，可使用此技能。

SKILL.md
--- frontmatter
name: commit-messages
description: Write clear commit messages. Use when asked to commit changes, write a commit message, prepare a commit, or describe changes for version control.

Committing Changes

Make small, atomic commits with clear messages.

Workflow

1. Understand the Changes

If you don't already understand the changes, review them first:

bash
git diff HEAD
git status --short

2. Stage and Commit

Make small, atomic commits—each commit should address one logical change. If your work spans multiple concerns (e.g., a refactor and a bug fix), break it into separate commits.

bash
# Stage entire files
git add <files>

# Or stage specific hunks for finer control
git hunks list                            # List all hunks with IDs
git hunks add 'file:@-old,len+new,len'    # Stage specific hunks by ID

git commit -m "title" -m "body paragraph"

3. Commit Message Format

Title (first line):

  • •Limit to 60 characters maximum
  • •Capitalize the first word of the main subject
  • •Use imperative mood ("add feature" not "adds feature")
  • •Use a short prefix for readability in git log --oneline (avoid "fix:" or "feature:" prefixes)

Body:

  • •Explain what the change does and why:
    • •Why are we making this change?
    • •What prompted it?
    • •What other solutions were tried/considered, if any?
    • •And why did we pick this one over the other(s)?
    • •Where was the bug introduced? (If applicable)
    • •Imagine you're explaining this to someone who has no context (yet)
    • •Illuminate blind alleys.
    • •What else might be a good option if this idea doesn't pan out?
  • •Use proper grammar and punctuation
  • •Use imperative mood throughout