AgentSkillsCN

generating-commit-messages

遵循项目规范，生成清晰、符合惯例的提交信息。在创建提交、撰写提交信息，或审查暂存的更改时，可使用此功能。

SKILL.md
--- frontmatter
name: generating-commit-messages
description: Generate clear, conventional commit messages following project rules. Use when creating commits, writing commit messages, or reviewing staged changes.
allowed-tools: Bash, Read, Grep

Generating Commit Messages

Overview

This project follows Conventional Commits. See .github/COMMIT_CONVENTION.md for the full specification.

Format

code
<prefix>: <subject>

[body]

[footer]

Prefix Types

PrefixUsageExample
featNew featurefeat: add user authentication
fixBug fixfix: resolve session timeout on login
docsDocumentation onlydocs: update API specification
styleStyle changes (no code behavior impact)style: fix indentation
refactorCode changes (not bug fix or feature)refactor: consolidate auth logic
perfPerformance improvementperf: resolve N+1 query issue
testAdd or modify teststest: add user service unit tests
choreBuild, tools, dependencieschore: update ESLint config
ciCI/CD configurationci: add tests to GitHub Actions

Workflow

  1. •

    Check staged changes:

    bash
    git diff --staged
  2. •

    Analyze the changes:

    • •What type of change is this? (feat, fix, refactor, etc.)
    • •What is the scope? (optional: auth, api, ui, etc.)
    • •What is the main purpose?
  3. •

    Write commit message:

    • •Subject: 50 chars max, present tense, imperative
    • •Body: Explain "why", not "what" (code shows what)
    • •Footer: Reference issues if applicable
  4. •

    Create commit:

    bash
    git commit -m "$(cat <<'EOF'
prefix: subject line here

Body explaining why this change was necessary.

Related: #123
EOF
)"

Rules

1. Use Present Tense

code
Bad:  Fixed the bug
Good: Fix the bug

Bad:  Added feature
Good: Add feature

2. One Commit = One Purpose

code
Bad:  fix: bug fix and refactoring
Good: fix: resolve login error
      (separate commit for refactoring)

3. Be Specific

code
Bad:  fix: bug fix
Good: fix: resolve pagination not working on user list

Bad:  refactor: refactoring
Good: refactor: extract duplicate validation logic to utility

4. Communicate "Why"

The diff shows what changed. The commit message should explain why.

code
Good example:
fix: resolve token validation error on password reset

UTC and local time comparison was not performed correctly.
This caused tokens to appear expired for users in certain timezones.

Fixes: #456

Scope (Optional)

Add scope for specific areas:

code
feat(auth): add social login
fix(api): resolve rate limit count error
test(user): improve user service test coverage

Bad Examples (Never Use)

code
update
fix bug
WIP
review fixes
fixed it
various changes

Footer References

code
Fixes: #123       # Closes issue
Related: #456     # References issue
Ticket: PROJ-789  # External ticket
See: https://...  # Documentation reference