提交信息生成器

提交详情

0/72 字符

必须填写摘要

解释什么和为什么，而不是如何

实时预览

填写详细信息以生成提交消息...

相关工具

模拟数据生成器生成模拟数据Markdown 预览器实时 Markdown 编辑器与预览代码差异检查器并排比较代码/文本

关于此工具

约定式提交规范是一个轻量级的提交消息约定。它提供了一套简单的规则来创建明确的提交历史，使得在此基础上编写自动化工具变得更容易。

提交消息格式

<type>(<scope>): <subject>

<body>

<footer>

优势

  • 自动生成变更日志（CHANGELOG）
  • 自动确定语义化版本号的升级
  • 向团队成员和利益相关者传达变更的性质
  • 触发构建和发布流程
  • 让人们更容易贡献，通过让他们探索更结构化的提交历史

常见类型

✨
feat — A new feature
🐛
fix — A bug fix
📚
docs — Documentation only changes
💎
style — Code style changes (formatting, etc)
♻️
refactor — Code refactoring
✅
test — Adding or updating tests

页脚用法

页脚是可选的，包含关于提交的元数据。常见用例包括：

破坏性变更: 使用 BREAKING CHANGE: 表示不兼容的 API 变更。这将触发语义化版本控制中的主版本号升级。
BREAKING CHANGE: API 端点现在需要身份验证
用户必须更新其 API 客户端以包含身份验证令牌
问题引用: 使用 Closes、Fixes 或 Resolves 等关键字将提交链接到问题跟踪器。
Closes #123
Fixes #456, #789
共同作者和审查者: 在提交中标注贡献者和审查者。
Co-authored-by: John Doe <john@example.com>
Reviewed-by: Jane Smith <jane@example.com>