用途:该技能用于辅助编写符合 Conventional Commits 1.0.0 规范的 git 提交信息,并在准备提交信息、概括代码变更时提供指引。\n\n提交格式:\n<type>[optional scope][!]: <description>\n[optional body]\n[optional footer(s)]\n\n各元素说明:type 为必填,表示变更的主要意图;feat 和 fix 对应语义化版本。其他允许的类型包括 docs、style、refactor、perf、test、build、ci、chore、revert。scope 可选,为括号内的简短组件或包名,例如 feat(parser): ...。! 可选,表示破坏性变更,可出现在 type 或 scope 之后。description 必填,使用祈使语气、小写、不加句末句点,建议不超过 72 个字符。body 可选,解释 what/why,约 72 字符换行。footers 可选,采用 Git trailer 格式,如 BREAKING CHANGE: ...、Refs: #123、Closes: #123。\n\n工作流:审阅变更并确定主要意图(功能、修复、文档等);选择 type 和可选 scope,若变更涉及多个意图,优先拆分为多个提交,否则选择影响最大的类型;判断是否为破坏性变更,若是则添加 ! 和/或 BREAKING CHANGE: footer;用祈使语气写简洁描述;按需添加 body 和 footer 以补充背景、理由或问题链接;最后对照检查清单校验。\n\n检查清单:头部符合 <type>(<scope>): <description> 格式;type 与变更相符(面向用户的行为用 feat/fix);描述为祈使语气、不超过 72 字符、无句末句点;破坏性变更以 ! 和/或 BREAKING CHANGE: 标注;footer 遵循 Token: value 格式。\n\n示例:feat(auth): add refresh token rotation;fix(api): handle empty payloads;docs: add migration guide;refactor(ui): extract button variants;perf(db): batch writes to reduce roundtrips;chore(deps): bump eslint to 9.0.0。破坏性变更示例:feat(api)!: drop deprecated v1 endpoints,并附 BREAKING CHANGE: v1 endpoints were removed. Use /v2 instead.。回滚示例:revert: feat(auth): add refresh token rotation,并注明 This reverts commit 1234abcd.。\n\n提示:为包或子系统使用 scope(如 api、ui、cli);避免在单个提交中混入不相关变更;仅格式变更使用 style 或 chore;流水线和依赖变更使用 ci 或 build;仅测试变更使用 test。\n\n限制:资料未提供安装命令、平台支持范围与收费信息,暂未提供此类内容。
commit
编程与开发
更新于 10-16 06:15