commit desk

Commit 规范生成与校验提交信息怎么写,填完直接复制

按 Conventional Commits 选 type、填 scope 与描述,工具实时拼出规范标题、正文与破坏性变更页脚;左侧生成,右侧可校验已有 commit 是否合规。

11 种 typescope破坏性变更正文排版格式校验
① 生成提交信息
结果
② 校验已有提交信息
检查结果
点「开始校验」查看结果。

校验只做格式检查,不判断描述内容是否准确。

📝口径说明与常见误填

subject 用祈使句、不加句号,72 字以内最稳。

为什么用 Conventional Commits
统一的标题格式让工具能自动判断版本号、生成 CHANGELOG。feat 对应 minor,fix 对应 patch,带 ! 的破坏性变更对应 major。
scope 怎么写
写受影响的模块名,如 image、api、docs;模块边界模糊时可以省略,不要写「更新」这种无信息量的词。
破坏性变更怎么标
标题 type(scope)!: 描述,并在页脚写 BREAKING CHANGE: 具体影响。两者最好同时存在。
校验做了什么
检查 type 是否在允许列表、冒号后空格、subject 长度与结尾标点、body 与标题是否空行分隔。不判断描述内容是否符合事实。

这个工具解决什么问题

Commit 规范生成与校验把「提交信息怎么写」变成填空:选择 type、填 scope 与描述,工具实时拼出符合 Conventional Commits 的标题;可加正文与破坏性变更页脚。另一半是校验器:把已有 commit message 粘进来,逐项检查 type、冒号空格、subject 长度、结尾标点与间距,指出哪里不合规。

写提交信息的三条经验

① 一句说清做了什么:用「新增/修复/移除」开头,别写「更新了一些内容」。

② scope 写模块:image、api、docs 这类具体范围,比「misc」有用。

③ 破坏性变更要标全:标题加 !,页脚写 BREAKING CHANGE,别只做一半。

怎么用

  1. 第 1 步 · 选择 type
    按改动性质选。
  2. 第 2 步 · 填写 scope 与描述
    描述控制在一行内。
  3. 第 3 步 · 复制提交
    需要就勾破坏性变更。
  4. 第 4 步 · 校验旧消息
    粘贴进来逐项检查。

更新记录

  • v1.0 2026-11-16
  • 首个版本:11 种 type、scope、破坏性变更页脚、实时生成、格式校验

常见问题

type 可以自定义吗?
当前用 Conventional Commits 常见 11 种,不支持自定义。
subject 有字数限制吗?
建议不超过 72 字,校验会标出超长。
scope 是必填吗?
不是,模块边界模糊时可留空。
BREAKING CHANGE 一定要写吗?
只有不兼容旧版本的改动才需要;普通功能不需要。
校验能发现内容错误吗?
不能,只检查格式,不判断描述是否符合实际改动。
信息会上传吗?
不会,生成与校验都在浏览器本地。

💬 留言板 0

全部留言需审核通过后展示
💬

还没有留言,来抢沙发吧!

✍️ 说点什么
0 / 500
图形验证码
👣 做完这一步,顺便看看
🧰 乱码修复 / 文本编码转换 在线乱码修复工具:上传乱码文本文件或粘贴乱码字符串,用 UT… → 💻 假装工作模拟器 老板走近工位的一瞬间,点一下就能从摸鱼切回正经工作界面。代码… → 🧰 IP / 子网掩码计算器 在线子网计算器:输入 IP 地址与掩码(CIDR 前缀或点分… → ⏰ 下班倒计时 打工人专属下班计算器:实时倒计时距离下班还有多久、进度环显示… →
全部工具 →