规范提交信息

3小时前更新 2 00

按约定式提交规范格式化Git提交

收录时间:
2026-02-25
规范提交信息规范提交信息
规范提交信息

技能简介

规范提交信息技能帮助按照Conventional Commits规范格式化所有Git提交信息。这支持自动生成变更日志、语义化版本控制,并提供更清晰的提交历史。

能做什么

  • 按标准格式编写提交信息
  • 支持自动化变更日志生成
  • 关联语义化版本号(MINOR/PATCH/MAJOR)
  • 标记破坏性变更(BREAKING CHANGE)
  • 提供多种提交类型选择
  • 支持可选的作用域(scope)标注

使用说明

安装指令:

clawhub install conventional-commits

提交格式结构:

type[optional scope]: description

optional body

optional footer(s)

主要提交类型:

  • feat: 新功能(对应MINOR版本)
  • fix: 修复bug(对应PATCH版本)
  • docs: 文档变更
  • style: 代码格式调整
  • refactor: 重构代码
  • perf: 性能优化
  • test: 测试相关
  • build: 构建系统变更
  • ci: CI/CD配置
  • chore: 其他杂项
  • revert: 回滚提交

描述规范:

  • 使用祈使语气(add feature而非added feature)
  • 首字母不大写
  • 末尾不加句号
  • 保持简洁(通常50-72字符)

破坏性变更标记:

方式1: 使用感叹号 feat!: 发送邮件给客户

方式2: 使用BREAKING CHANGE脚注

示例:

feat(auth): 添加OAuth2支持

fix: 防止请求竞争

docs: 修正CHANGELOG拼写错误

输入与输出

见下方输入与输出表格。

项目内容
输入代码变更内容、变更类型(feat/fix等)、作用域(可选)、变更描述、破坏性变更标记
输出规范格式的提交信息、语义化版本建议、变更日志条目、破坏性变更警告
适用人群开发团队、开源项目维护者、需要自动化版本管理的项目、追求清晰提交历史的团队
不包含自动提交工具、提交前钩子强制检查、与特定CI/CD平台的集成、提交信息模板生成器

 

风险提示

  • 团队需要统一遵循该规范才能发挥效果
  • 自动化工具依赖准确的提交类型判断
  • 破坏性变更必须明确标记以避免意外
  • 原始页面信息充足,可直接使用

来源信息

原始链接:https://github.com/openclaw/skills/tree/main/skills/bastos/conventional-commits/SKILL.md
来源类型:github

数据统计

相关导航

暂无评论

none
暂无评论...