用途:为当前代码改动创建一条高质量的 Git 提交,遵循 Conventional Commits 规范,并在提交前进行质量与范围检查。
主要能力:提供提交前检查清单,包括范围检查(只解决一个问题、无无关改动、无调试代码、无临时文件)和质量检查(测试通过、代码已格式化、无 lint 错误、文档已更新)。规定提交信息格式为 <type>(<scope>): <description>,后接 body 与 footer。
类型取值:feat(用户可见的新功能)、fix(缺陷修复)、docs(仅文档)、test(新增或更新测试)、refactor(重构,不改变行为)、style(格式调整,不改变逻辑)、chore(维护、依赖)、perf(性能改进)。scope 可选,用于标明受影响的模块、组件或文件,如 feat(auth): add login endpoint。description 必填,要求 50 字符以内、现在时祈使语气、首字母小写、结尾不加句号,描述做了什么而非怎么做。
使用方式:按清单逐项确认后,依据上述格式撰写提交信息;资料未提供具体安装命令或调用命令。
适用场景:需要统一团队提交规范、提升提交历史可读性、便于自动生成变更日志或关联 issue(如 Closes #42、Fixes #67)的项目。
限制:资料仅给出规范与检查清单,未说明支持的平台、集成方式、收费情况或自动化程度,这些暂未提供。