用途:在提交代码前分析改动并生成符合 Conventional Commits 1.0.0 的提交信息。
主要能力:运行 git status 与 git diff HEAD 分析变更;仅暂存用户指定文件,或使用 git add -A 暂存全部;根据改动判断类型与 scope;结合用户提示生成提交信息,并用 HEREDOC 保留格式提交;输出形如 <hash> <subject>。
提交格式为 <type>[optional scope][!]: <description>,可带 body 与 footer。类型含 feat、fix、perf、refactor、style、test、docs、build、ci、revert、chore;仅 feat 与 fix 有 SemVer 影响(MINOR、PATCH),破坏性变更触发 MAJOR。标题建议不超过 72 字符,使用祈使现在时、首字母小写、不加句点。scope 用名词描述模块或区域。body 与标题空一行,说明 what 与 why,每行 72 字符换行。footer 采用 git trailer 格式,常见有 BREAKING CHANGE、Refs、Closes、Co-authored-by 等。破坏性变更可在标题冒号前加 !,或在 footer 写 BREAKING CHANGE:。
边界:只分析改动、生成并提交信息,不修改代码、不推送(除非被要求)、不创建分支、不擅自 amend。
限制与缺失信息:资料未提供安装方式、配置项、平台支持及收费情况,暂未提供。