SuperAPI AI 工具集

conventional-commits

通用与其它

查看项目

更新于 10-15 21:09

技能介绍

这是一个用于编写符合 Conventional Commits 规范(v1.0.0)的 Git 提交的技能,适用于创建提交、审查 PR 中的提交信息、撰写结构化提交消息以及多人协作场景。

提交消息基础格式为:<type>[optional scope]: <description>,其后可跟可选的正文(body)与脚注(footer)。常用类型包括 feat(新功能)、fix(修复)、docs(文档)、style(不影响含义的格式调整)、refactor(重构)、perf(性能)、test(测试)、chore(构建流程、依赖或维护),较少用的还有 build、ci、revert。作用域(scope)可选,用于说明改动范围,如 auth、api、ui、database 或 db、services、jobs、tests、deps、config、docs。

描述要求使用祈使句现在时(如 add 而非 added/adds),首字母不大写,结尾不加句号,建议 50 字符以内、不超过 72 字符。正文与描述之间空一行,使用祈使语气并每行约 72 字符换行;脚注用于标注破坏性变更、关联 issue 和协作者等。破坏性变更可用 BREAKING CHANGE: 脚注,或直接在类型/作用域后加 !(如 feat!、feat(api)!)。

最佳实践:保持提交原子性、每个提交只做一件逻辑改动、在正文解释原因而非重复代码可见的改动、用脚注引用 issue/PR。资料未提供安装命令、许可或具体集成方式。