AgentSkillsCN

git

版本控制、提交信息与分支策略的标准规范

SKILL.md
--- frontmatter
name: git
description: Standards for version control, commit messages, and branching strategy
allowed-tools: run_command
version: 1.0
priority: CRITICAL

Git - Version Control Standards

CRITICAL SKILL - Maintain a clean, traversable, and semantic history.

Core Principles

PrincipleRule
Atomic CommitsOne logical change per commit (e.g., "Fix bug" vs "Fix bug and add feature")
Conventional CommitsUse structured messages (feat, fix, docs, refactor, etc.)
Clean HistoryDon't commit broken code. Squash WIP commits before merging.
Ignore ArtifactsNever commit derived files (builds, local configs, secrets).

Commit Message Convention

Follow the Conventional Commits specification:

text
<type>(<scope>): <subject>

<body>

<footer>

Types

TypeDescription
featA new feature
fixA bug fix
docsDocumentation only changes
styleChanges that do not affect the meaning of the code (white-space, formatting, etc)
refactorA code change that neither fixes a bug nor adds a feature
perfA code change that improves performance
testAdding missing tests or correcting existing tests
choreChanges to the build process or auxiliary tools and libraries

Examples

Good:

  • •feat(auth): implement jwt token validation
  • •fix(search): handle empty result sets gracefully
  • •docs(readme): update installation instructions

Bad:

  • •update code
  • •fix bug
  • •wip

Workflow Rules

  1. •

    Before Committing:

    • •Check git status to see what will be staged.
    • •Run git diff to review changes line-by-line.
    • •Ensure sensitive data (API keys) is NOT included.
  2. •

    Branching (if applicable):

    • •main / master: Stable production code.
    • •develop / dev: Integration branch.
    • •feat/feature-name: Feature branches.
    • •fix/issue-description: Bug fix branches.
  3. •

    Handling Conflicts:

    • •Pull changes from remote often to minimize conflicts.
    • •Resolve conflicts manually, understanding both sides of the change.

Common Commands Checklist

ActionCommand
Check Statusgit status
View Changesgit diff
Stage Filesgit add <file> (Avoid git add . unless sure)
Commitgit commit -m "type(scope): message"
Loggit log --oneline --graph --decorate --all

🔴 Self-Check Before Committing

Ask yourself:

  1. •Does this commit break the build?
  2. •Did I accidentally include node_modules, venv, or .env?
  3. •Is the commit message descriptive enough for someone else to understand 6 months from now?