工具介绍
Git提交信息生成器帮助你快速生成符合Angular提交规范的Git Commit Message,规范的提交信息能让项目历史更清晰、便于后续维护和版本发布。
使用方法
按以下步骤填写信息即可自动生成规范的提交信息:
- 选择本次提交的类型(不同类型有对应的中文说明)
- (可选)填写本次修改影响的范围,例如用户模块、支付接口
- 填写本次提交的简要描述,建议控制在50字以内
- (可选)填写关联的Issue编号,例如#123
- 如果本次提交包含不兼容的破坏性变更,请勾选对应选项
- 点击「复制结果」按钮即可复制生成的提交信息到剪贴板
格式说明
生成的提交信息遵循以下格式规范:
<type>[(<scope>)]!: <subject> [body]
- type:提交类型,决定本次提交的分类
- scope:影响范围,可选,说明本次修改影响的模块/区域
- !:仅当包含破坏性变更时添加,用于标识不兼容变更
- subject:提交的简要描述
- body:详细说明,这里用于填写关联的Issue信息
类型说明对照表
| 类型 | 说明 |
|---|---|
| feat | 新增功能 |
| fix | 修复问题 |
| docs | 仅文档修改 |
| style | 代码格式调整,不影响代码运行(比如空格、分号格式等) |
| refactor | 代码重构,既不新增功能也不修复问题 |
| perf | 性能优化 |
| test | 添加/修改测试用例 |
| chore | 构建过程/辅助工具的变更,不影响源代码 |