name: commit description: “创建符合规范的提交信息。使用场景:提交已暂存的更改。触发条件:‘/commit’,‘conventional commit’。” allowed-tools: Bash disable-model-invocation: true argument-hint: <类型>[范围]: <描述> [可选正文] [可选脚注]
创建符合规范的提交信息
我将帮助您按照 Conventional Commits 1.0.0 规范创建一个提交信息。
检查当前更改
!git status --short
!git diff --cached --stat
分析更改
根据更改内容,我将按照以下结构创建提交信息:
<类型>[可选范围]: <描述>
[可选正文]
[可选脚注]
规范提交类型
- feat: 新功能(对应 SemVer 中的 MINOR)
- fix: 错误修复(对应 SemVer 中的 PATCH)
- docs: 仅文档更改
- style: 不影响代码含义的更改(空格、格式等)
- refactor: 既不修复错误也不添加功能的代码更改
- perf: 提高性能的代码更改
- test: 添加或更正测试
- build: 构建系统或依赖项的更改
- ci: CI 配置文件和脚本的更改
- chore: 不修改源代码或测试文件的其他更改
- revert: 恢复之前的提交
重大变更
- 在类型/范围后添加 ! 表示重大变更(例如,feat!: 或 feat(api)!:)
- 或者在脚注中包含 BREAKING CHANGE:
创建提交
重要提示:此命令永远不会执行 git add。它仅从已暂存的更改创建提交。
根据暂存的更改和 “$ARGUMENTS” 中的任何特定要求,我将:
- 确定适当的提交类型
- 识别是否需要范围
- 编写清晰、简洁的描述
- 如果更改复杂,则添加正文详细信息
- 包含任何必要的脚注(BREAKING CHANGE、引用等)
然后使用以下命令执行提交:
git commit -m "$(cat <<'EOF'
[生成的提交信息在此处]
EOF
)"
重要提示:提交信息将保持干净和专业,包含:
- 规范提交格式(类型、范围、描述)
- 根据需要可选正文和脚注
提交将遵循所有 Conventional Commits 1.0.0 规则:
- 类型前缀是必需的
- 描述紧跟在冒号和空格之后
- 正文(如果包含)在描述后空一行开始
- 脚注(如果包含)在正文后空一行开始
- 重大变更被明确标识