跳至正文
OpenAgentSkill
浏览已开放 · 目录记录日期 2026-11-21 · 自动更新和账户服务暂时关闭。
浏览器与自动化

commit

Stage and commit changes with proper formatting following repo conventions

rlajous · 已有 AI 审核记录

安装与使用

运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。

npx skills add rlajous/claude-code-commands --skill commit

技能说明


name: commit description: Stage and commit changes with proper formatting following repo conventions disable-model-invocation: false allowed-tools: Read, Grep, Glob, Bash(git status:), Bash(git diff:), Bash(git add:), Bash(git commit:), AskUserQuestion, Edit user-invocable: true

Cross-runtime: follow runtime compatibility for invocation, delegation, configuration precedence, state paths, and permissions.

You are helping commit changes for a pull request. Your task is to stage changes, generate a properly formatted commit message following project conventions, and handle pre-commit hooks.

Step 1: Load Configuration

Check for configuration and context:

# Check for config and context files
if [ -f ".git-workflow/config.yaml" ]; then CONFIG_PATH=".git-workflow/config.yaml"; elif [ -f ".claude/config.yaml" ]; then CONFIG_PATH=".claude/config.yaml"; else CONFIG_PATH=""; fi
if [ -f ".git-workflow/pr-context.json" ]; then CONTEXT_PATH=".git-workflow/pr-context.json"; elif [ -f ".claude/.pr-context.json" ]; then CONTEXT_PATH=".claude/.pr-context.json"; else CONTEXT_PATH=""; fi

Load from the resolved CONFIG_PATH (canonical first, legacy read-only fallback):

commits:
  format: "[{type}] {message} ({ticket})"
  types: [Feature, Fix, Hotfix, Refactor, Docs, Test, Chore]
  requireTicket: false
  ticketPattern: "^[A-Z]+-\\d+$"
attribution:
  enabled: false
  format: ""

Load from the resolved CONTEXT_PATH (canonical first, legacy read-only fallback):

{
  "ticket_id": "PROJ-1234",
  "type": "fix",
  "branch": "fix/proj-1234-description"
}

Default Values (when no config):

commits:
  format: "[{type}] {message} ({ticket})"
  types: [Feature, Fix, Hotfix, Refactor, Docs, Test, Chore]
  requireTicket: false
attribution:
  enabled: false

Step 2: Gather Context

If .pr-context.json doesn't exist or is incomplete, ask for missing information:

Missing Ticket ID

If commits.requireTicket: true or no ticket found in context:

Question: "What is the ticket ID for this commit?"

  • Example: PROJ-1234, ENG-456
  • Allow skipping if requireTicket: false

Missing Change Type

If type not found in context:

Question: "What type of change is this?"

Options: Feature, Fix, Hotfix, Refactor, Docs, Test, Chore

Step 3: Show Changed Files

Display what will be staged:

# Show git status
git status --short

# Show detailed diff stats
git diff --stat
git diff --cached --stat

Present to user:

Changes to be committed:

Staged:
  M src/file1.ts
  A src/file2.ts

Unstaged:
  M src/file3.ts
  M tests/file1.test.ts

Do you want to stage all changes, or select specific files?

Options:

  1. Stage all changes (default)
  2. Stage only unstaged changes
  3. Select specific files
  4. Review diff before staging

If user wants to review diff:

git diff

Step 4: Stage Files

Based on user's choice:

Stage All

git add -A

Stage Specific Files

git add {file1} {file2} ...

Confirmation

# Show what's staged
git diff --cached --name-only

Step 5: Generate Commit Message

Ask for Summary

Question: "What is the summary of your changes?"

Guidelines:

  • Use imperative mood ("Add feature" not "Added feature")
  • Be concise (50-72 characters)
  • Focus on what and why, not how

Examples:

  • "Add user authentication with OAuth2"
  • "Fix memory leak in connection pool"
  • "Update dependencies to latest versions"

Format Message

Apply commit format from config (default: [{type}] {message} ({ticket})):

VariableSourceExample
{type}Context or user inputFix
{message}User-provided summaryFix login timeout
{ticket}Context or user inputPROJ-1234

Type Capitalization:

  • fix -> Fix
  • feature -> Feature
  • hotfix -> Hotfix

Result Examples:

  • [Fix] Standardize token_info schema (PROJ-1234)
  • [Feature] Add holder analysis endpoint (ENG-456)
  • [Chore] Update dependencies (no ticket)

Handle Missing Ticket

If no ticket and format includes ({ticket}):

  • If requireTicket: true: Prompt for ticket
  • If requireTicket: false: Omit the ({ticket}) part
Without ticket: [Fix] Update dependencies
With ticket: [Fix] Update dependencies (PROJ-1234)

Step 6: Commit Changes

Create Commit

git commit -m "{formatted_commit_message}"

Important: Let pre-commit hooks run. Do NOT use --no-verify.

Handle Pre-commit Failures

If commit fails due to pre-commit hooks:

  1. Identify the issue:

    # Check hook output for errors
    # Common issues: linting, formatting, type errors
    
  2. Auto-fix if possible:

    # For ESLint/Prettier
    npm run lint:fix 2>/dev/null || pnpm lint:fix 2>/dev/null || yarn lint:fix 2>/dev/null
    
    # For Python
    black . 2>/dev/null || ruff format . 2>/dev/null
    
  3. Re-stage fixed files:

    git add -A
    
  4. Retry commit:

    git commit -m "{formatted_commit_message}"
    
  5. If still failing:

    • Show the error to the user
    • Ask if they want to fix manually or skip hooks (not recommended)

Attribution (If Enabled)

If attribution.enabled: true in config, append the configured prose note to the commit body. The note must comply with repository commit rules and must not impersonate or add another commit author.

git commit -m "{message}

{attribution.format}"

Example:

[Fix] Update token schema (PROJ-1234)

This commit was created with assistance from an AI coding agent.

Note: Attribution is disabled by default.

Step 7: Update Context

Update .git-workflow/pr-context.json:

mkdir -p .git-workf
阅读完整来源 ↗