AgentSkillsCN

prowler-commit

按照Conventional Commits格式创建专业的git提交。触发条件：创建提交时、完成代码更改后、用户要求提交时。

SKILL.md
--- frontmatter
name: prowler-commit
description: >
  Creates professional git commits following conventional-commits format.
  Trigger: When creating commits, after completing code changes, when user asks to commit.
license: Apache-2.0
metadata:
  author: prowler-cloud
  version: "1.1.0"
  scope: [root, api, ui, prowler, mcp_server]
  auto_invoke:
    - "Creating a git commit"
    - "Committing changes"

Critical Rules

  • •ALWAYS use conventional-commits format: type(scope): description
  • •ALWAYS keep the first line under 72 characters
  • •ALWAYS ask for user confirmation before committing
  • •NEVER be overly specific (avoid counts like "6 subsections", "3 files")
  • •NEVER include implementation details in the title
  • •NEVER use -n flag unless user explicitly requests it
  • •NEVER use git push --force or git push -f (destructive, rewrites history)
  • •NEVER proactively offer to commit - wait for user to explicitly request it

Commit Format

code
type(scope): concise description

- Key change 1
- Key change 2
- Key change 3

Types

TypeUse When
featNew feature or functionality
fixBug fix
docsDocumentation only
choreMaintenance, dependencies, configs
refactorCode change without feature/fix
testAdding or updating tests
perfPerformance improvement
styleFormatting, no code change

Scopes

ScopeWhen
apiChanges in api/
uiChanges in ui/
sdkChanges in prowler/
mcpChanges in mcp_server/
skillsChanges in skills/
ciChanges in .github/
docsChanges in docs/
omitMultiple scopes or root-level

Good vs Bad Examples

Title Line

code
# GOOD - Concise and clear
feat(api): add provider connection retry logic
fix(ui): resolve dashboard loading state
chore(skills): add Celery documentation
docs: update installation guide

# BAD - Too specific or verbose
feat(api): add provider connection retry logic with exponential backoff and jitter (3 retries max)
chore(skills): add comprehensive Celery documentation covering 8 topics
fix(ui): fix the bug in dashboard component on line 45

Body (Bullet Points)

code
# GOOD - High-level changes
- Add retry mechanism for failed connections
- Document task composition patterns
- Expand configuration reference

# BAD - Too detailed
- Add retry with max_retries=3, backoff=True, jitter=True
- Add 6 subsections covering chain, group, chord
- Update lines 45-67 in dashboard.tsx

Workflow

  1. •

    Analyze changes

    bash
    git status
git diff --stat HEAD
git log -3 --oneline  # Check recent commit style
  2. •

    Draft commit message

    • •Choose appropriate type and scope
    • •Write concise title (< 72 chars)
    • •Add 2-5 bullet points for significant changes
  3. •

    Present to user for confirmation

    • •Show files to be committed
    • •Show proposed message
    • •Wait for explicit confirmation
  4. •

    Execute commit

    bash
    git add <files>
git commit -m "$(cat <<'EOF'
type(scope): description

- Change 1
- Change 2
EOF
)"

Decision Tree

code
Single file changed?
├─ Yes → May omit body, title only
└─ No → Include body with key changes

Multiple scopes affected?
├─ Yes → Omit scope: `feat: description`
└─ No → Include scope: `feat(api): description`

Fixing a bug?
├─ User-facing → fix(scope): description
└─ Internal/dev → chore(scope): fix description

Adding documentation?
├─ Code docs (docstrings) → Part of feat/fix
└─ Standalone docs → docs: or docs(scope):

Commands

bash
# Check current state
git status
git diff --stat HEAD

# Standard commit
git add <files>
git commit -m "type(scope): description"

# Multi-line commit
git commit -m "$(cat <<'EOF'
type(scope): description

- Change 1
- Change 2
EOF
)"

# Amend last commit (same message)
git commit --amend --no-edit

# Amend with new message
git commit --amend -m "new message"