开发者 / Git

Conventional Commit 提交信息助手(生成器与检查工具)

按照 Conventional Commits 1.0.0 格式创建提交信息:选择类型,添加作用域和描述,标记突破性变更,添加正文和页脚,并查看 semantic-release 等工具会据此执行的版本发布。

Conventional Commit 提交信息助手(生成器与检查工具): 此工具会将第一行写成 type(scope): description;如果是突破性变更,则会在作用域后添加!。正文和页脚会在空行后添加,其中包括带有迁移说明的 BREAKING CHANGE:。工具会提示第一行是否超过72个字符、末尾是否有句号,以及首字母是否大写,并显示该提交会触发主版本、次版本还是补丁版本发布。 完全在浏览器中本地运行,文件不会上传到服务器。

使用次数
在浏览器中
费用
免费·无需注册
可用性
可直接使用
提交信息助手本地处理

完全在浏览器中运行

提交信息

feat(auth): add login with passkeys

首行35个字符·发布版本:minor(新功能)

Conventional Commits1.0.0:type(scope):description,空行后可添加正文,并可添加BREAKING CHANGE:等页脚。type后的!表示破坏性更改。semantic-release和release-please等工具会读取这些信息,以确定下一个版本号并编写更新日志。

示例

feat(auth)!:添加使用通行密钥登录的提交消息,其中包含一个空行、一段解释原因的正文,以及BREAKING CHANGE:会话现在会在24小时后过期。由于包含!,发布工具会将其生成一个主版本。

版本

Conventional Commits对应语义化版本控制:fix对应补丁版本,feat对应次版本,破坏性变更对应主版本。使用语义化版本计算器计算下一个版本号。

使用方法

  1. 选择类型,例如 feat 或 fix,并添加可选的作用域。
  2. 编写简短描述;如果存在突破性变更,请将其标记出来。
  3. 根据需要添加正文或页脚,然后复制提交信息。

隐私与限制

所有操作都在你的浏览器中运行。

相关工具

常见问题

feat 和 fix 有什么区别?

feat 添加用户可以使用的新功能,并产生次版本发布;fix 修复错误,并产生补丁版本发布。

什么情况下属于突破性变更?

当现有用户必须更改某些内容才能继续使用时,例如移除某个选项、重命名函数或更改默认值。

我必须使用 Conventional Commits 吗?

不必,但 semantic-release、release-please 和 commitlint 等工具依赖它来自动管理版本号和变更日志。

免费工具·使用在浏览器中次·无需账户