用途:该技能在创建 git 提交时提供约束与指引,确保提交信息符合 Conventional Commits 规范,并通过类型前缀区分是否会触发发布流程(生成 changeset、触发 npm 发布)。
格式要求:提交信息写作 <type>[(scope)]: <description>。类型与描述均使用小写;句末不加句号;使用祈使语气,例如用 add 而不是 added;总长度少于 100 个字符;scope 为可选项,用于标注包或功能区域,示例包括 init、deploy、cli-core、deps、ci。
触发发布的类型:feat 对应 minor 版本号更新,用于新命令、新标志、新功能;fix 对应 patch,用于缺陷修复、崩溃修复、输出错误;perf 对应 patch,用于性能改进;revert 对应 patch,用于回滚之前的改动;feat! 或 fix! 对应 major,用于破坏性变更,例如移除命令、改变标志行为。这些类型会生成 changeset 并触发 npm 发布。
非发布类型:chore 用于工具、构建配置、依赖更新;refactor 用于不改变行为的代码重构;test 用于新增或更新测试;docs 仅用于文档;style 用于格式与空白;build 用于构建系统变更;ci 用于 CI/CD 流水线变更。这些类型不会触发发布或 changeset。
决策指引:若改动影响用户体验,使用 feat 或 fix;若破坏现有行为,在类型后加感叹号(如 feat!);若仅涉及内部且对用户无影响,使用 chore、refactor、test 等;依赖更新一般用 chore(deps),但若修复了面向用户的缺陷则用 fix(deps)。
示例:feat: auto-generate changesets from PR descriptions;feat(embeddings): add projection validation using groq-js;feat(cli): inject SANITY_STAGING global in staging builds;fix(init): strip filename before counting nested folders in import path;fix(deploy): stop spinner before returning from app lookup;refactor(cli-core): replace oclif ux.colorize with node:util styleText;refactor(cli): migrate from zod to zod/mini for smaller bundle size;chore: skip auto-generated changeset when one already exists;chore(ci): use squiggler-app bot as changeset commit author;chore(deps): update swc-tooling。
适用场景:适用于采用 Conventional Commits 并使用 changeset 与 npm 发布流程的项目,尤其是本资料对应的 sanity-io/cli 仓库。
限制:资料未提供安装命令、运行方式、配置项、价格与平台兼容性等细节,暂未提供。