用途:根据代码改动生成符合 Conventional Commits 1.0.0 规范的提交信息,并在需要时暂存文件、执行提交。
主要能力:分析 git 差异,推断 type、scope 与是否破坏性变更;起草 subject、body、footer;用 git 命令完成暂存与提交。支持的类型包括 feat、fix、perf、refactor、style、test、docs、build、ci、chore、revert;破坏性变更可用 type/scope 后的 ! 或 BREAKING CHANGE: footer 表示。
用法:先运行 git status 和 git diff HEAD;仅暂存用户指定文件,若用户要求“all”则用 git add -A;随后按 HEREDOC 方式提交: git commit -m "$(cat <<'EOF' <type>(<scope>): <description>
<body>
<footer> EOF )" 最终只输出 <hash> <subject>。
格式要求:subject 不超过 72 字符(建议 50),使用祈使、现在时、首字母小写、不加句号;body 说明 what/why 并按 72 列换行;footer 使用 <token>: <value> 或 <token> #<value>,常见 token 有 BREAKING CHANGE、Refs、Closes、Fixes、Co-authored-by 等。scope 可选,用名词表示受影响模块,不明确时省略。
限制:仅做分析改动、生成信息、暂存与提交;不修改代码、不推送、不创建分支,除要求外不 amend。推断不明确时才询问用户。资料未提供安装方式与收费信息。