SuperAPI AI 工具集

git-conventions

部署与运维

查看项目

更新于 10-15 21:51

技能介绍

用途:该技能为团队和个人提供 Git 约定与工作流规范指导,帮助维护清晰、可读的仓库历史。适用场景包括编写符合规范的提交信息、建立团队 Git 工作流、制定分支命名约定、实施 Conventional Commits、实现 changelog 自动化、代码审查中的 Git 规范检查,以及新成员 Git 实践培训。

主要能力:

  1. 提交规范:采用 Conventional Commits,格式为 <type>[optional scope]: <description>,可选正文与脚注。类型包含 feat、fix、docs、style、refactor、perf、test、build、ci、chore、revert。主题行使用祈使语气、首字母不大写、结尾不加句号、软限制 50 字符,与正文空行分隔;正文 72 字符换行,说明 what 与 why;脚注支持 BREAKING CHANGE、Closes/Fixes/Refs 引用,以及 Co-authored-by。
  2. 分支命名:格式 <type>/<issue-number>-<short-description>,常用前缀 feature/、feat/、fix/、bugfix/、hotfix/、release/、docs/、refactor/、test/、chore/、experimental/、spike/。规则:用连字符不用下划线、小写、简短描述(最多 50 字符)、尽量包含 issue 编号、避免特殊字符、不留结尾斜杠、团队内保持一致。
  3. 分支保护:main/master 保持可部署且受保护、禁止直接提交;develop 作集成分支;staging 预生产。保护规则可要求 PR 审查、状态检查、线性历史等。
  4. 语义化版本:MAJOR.MINOR.PATCH[-prerelease][+build]。破坏性变更升 MAJOR,向后兼容新功能升 MINOR,缺陷修复与安全补丁升 PATCH。附 git tag 创建与推送示例命令。
  5. 工作流模式:Git Flow(main/develop/feature/release/hotfix)、GitHub Flow(main 常可部署 + 功能分支)、主干开发(短生命周期分支、频繁集成、功能开关)。含功能、发布、热修复流程示例命令。
  6. PR 约定:标题用 Conventional Commits 格式,描述模板含 Summary、Changes、Testing、Screenshots、Related Issues、Checklist。审查清单涵盖风格、提交规范、测试、文档、安全、性能、破坏性变更。
  7. Changelog 管理:Keep a Changelog 格式(Added、Changed、Deprecated、Removed、Fixed、Security),可配合 conventional-changelog、release-please、semantic-release 等工具自动生成。

使用方式:作为技能在相关任务中激活,例如请求撰写提交信息、制定分支规范或搭建工作流时,技能将按上述约定给出指导与模板。资料提及 assets/、templates/、examples/、tools/、references/ 等目录,但未提供具体安装命令与调用方式。

限制:资料仅提供规范与示例,未说明具体平台兼容性、版本号或更新日期,部分工具仅列出名称,未给出完整配置或安装步骤。团队应在仓库文档中记录并统一约定。