用途:帮助用户按 Conventional Commits 规范编写清晰、专业的 Git 提交信息,可识别并响应斜杠命令。
主要能力:/commit 为智能提交助手,若代码已暂存则自动分析,否则转为交互式;/validate <message> 校验提交信息格式;/types 列出全部提交类型及说明;/scopes 解释 scope 并给出示例;/breaking 指导创建破坏性变更提交;/changelog 依据近期提交生成变更日志;/version 根据提交判定下一个语义化版本;/examples 展示综合示例;/fix 帮助修改上一次提交。
提交格式:<type>(<scope>): <description>,可带 body 与 footer。类型含 feat、fix、refactor、perf、style、test、docs、build、ops、chore;scope 可选;description 小写、祈使语气、无句号、100 字符以内。破坏性变更在冒号前加 !,并在 footer 写 BREAKING CHANGE 说明及迁移方式。
使用方式:按用户意图进入不同模式。智能提交模式下先运行 git diff --staged --name-only 检查暂存文件,若为暂存状态则运行 scripts/analyze-diff.py --json 解析类型、scope、描述、置信度与破坏性,给出建议并询问确认;无暂存改动时进入交互式构建;用户已提供描述时直接手工构建。另附 scripts/validate.py 可校验格式或用作 git hook。修改上次提交建议 git commit --amend,较旧提交建议交互式 rebase(资料未给出具体命令)。
校验要点:类型须在允许列表内、描述小写、结尾无句号、100 字符以内、破坏性标识与 footer 一致、使用祈使语气。
适用场景:编写或审阅提交信息、生成变更日志、判断版本号、修正提交。
限制:资料未提供安装与配置方式、脚本运行环境要求、收费或授权信息;部分命令示例仅给出思路,未提供完整参数。