用途:在提交 git 改动时,按 Conventional Commits 规范生成语义化提交信息。
主要能力:提供提交格式 <type>[可选 scope]: <description>,以及可选正文与页脚;给出 feat、fix、docs、style、refactor、perf、test、build、ci、chore、revert 等类型说明;提供从检查状态、暂存、审查差异、分析类型与范围、撰写信息到执行提交的工作流。
使用方式:先运行 git status --short、git diff --cached --stat、git diff --stat 检查仓库状态;若无暂存改动,询问要暂存哪些文件,只暂存本次任务改动的文件;用 git diff --cached 审查已暂存差异;再确定类型与范围并撰写信息,最后执行 git commit。
写作要求:主题行用祈使语气,尽量 50 字符内,不加句号,说明改了什么而非怎么改;正文在空行后补充动机、与旧行为对比或副作用;页脚用 Token: value 格式(token 中空格用 - 代替),如 Closes #123、Co-authored-by、Reviewed-by;破坏性变更需在描述或正文中清楚说明,无需特殊标记。
适用场景:提交用户可见功能、修复缺陷、文档、格式、重构、性能、测试、构建、CI、杂项或回滚等改动。
限制:资料未提供安装命令、平台支持、收费与价格信息;强调清晰与实用优先于严格符合规范,scope 仅在确有助益时添加,不相关的改动应拆分为多个提交。