prowler-commit

关键规则

• 始终使用 conventional-commits 格式：type(scope): description
• 始终将第一行控制在 72 个字符以内
• 提交前始终征求用户确认
• 绝不要过于具体（避免使用“6 个小节”“3 个文件”等数量）
• 标题中绝不要包含实现细节
• 除非用户明确要求，否则绝不要使用 -n 标志
• 绝不要使用 git push --force 或 git push -f（具有破坏性，会重写历史记录）
• 绝不要主动提出提交；等待用户明确提出请求

---

提交格式

type(scope): concise description

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

类型

类型	使用场景
feat	新增功能
fix	修复错误
docs	仅涉及文档
chore	维护、依赖项、配置
refactor	不涉及新增功能或修复的代码更改
test	添加或更新测试
perf	性能改进
style	格式调整，不涉及代码更改

范围

范围	适用情况
api	更改位于 api/
ui	更改位于 ui/
sdk	更改位于 prowler/
mcp	更改位于 mcp_server/
skills	更改位于 skills/
ci	更改位于 .github/
docs	更改位于 docs/
省略	涉及多个范围或根目录

---

正反示例

标题行

# 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

正文（项目符号）

# 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

---

工作流

1. 分析更改

   git status
   git diff --stat HEAD
   git log -3 --oneline  # Check recent commit style
   

2. 起草提交信息

   • 选择合适的类型和范围
   • 编写简洁的标题（< 72 个字符）
   • 为重要更改添加 2-5 个项目符号

3. 提交给用户确认

   • 显示要提交的文件
   • 显示拟定的提交信息
   • 等待用户明确确认

4. 执行提交

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

---

决策树

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):

---

命令

# 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"