SuperAPI AI 工具集

conventional-commits

通用与其它

查看项目

更新于 10-16 06:15

技能介绍

用途:按 Conventional Commits 规范统一格式化 Git 提交信息,便于自动生成变更日志、做语义化版本管理并保持提交历史清晰。

主要能力与格式:结构为 <type>[可选 scope]: <description>,其后可接可选正文与页脚。必用类型有 feat(新功能,对应语义化版本 MINOR)和 fix(缺陷修复,对应 PATCH);常见附加类型包括 docs、style、refactor、perf、test、build、ci、chore、revert。scope 可选,用于说明代码库中的具体模块,如 feat(parser)、fix(auth)、docs(readme)。

description 紧跟冒号加空格,使用祈使语气,首字母小写,末尾不加句号,通常控制在 50-72 字符。正文可选,需与描述之间空一行,可多段,说明改动的 what 与 why 而非 how。

破坏性变更:可在类型或 scope 后加 !,如 feat!、feat(api)!;也可使用 BREAKING CHANGE 页脚;两者可同时使用。语义化版本对应关系为 fix→PATCH、feat→MINOR、BREAKING CHANGE→MAJOR。

使用场景:所有 git 提交、生成提交信息、PR 合并提交,以及用户提及提交或 git 提交时。

限制与常见错误:每个提交必须以类型加冒号空格开头,一次提交聚焦一个逻辑改动;避免过去时或首字母大写(如 Added new feature)、描述过于笼统(如 fix: bug)、冗余(如 feat: add feature)以及末尾加句号。

该技能来源页面未提供安装命令、平台支持范围或收费信息。