一个标准的Git Message提交应该包含什么:
一个完整的Git Message提交应该包括标题和正文两个部分。标题应简洁明了,描述主要修改,而正文部分则提供更详细的修改信息。如果有相关的问题单号或代码审查链接,也应在正文中给出。
一个标准的Git提交信息(commit message)应该清晰、简洁且易于他人理解。它通常包括以下部分来确保高质量的提交历史:
- 标题行(Summary Line): 最重要的一行,简洁明了地概述改动的主要目的,限制在50个字符以内。应该能够让人一眼看出这次提交做了什么。
- 正文(Body): 对改动进行详细描述。应当说明为什么做这个改动,这个改动的上下文,以及与之前行为的对比。这部分是可选的,但对于复杂的更改来说非常重要。正文每行应该限制在72个字符以内,以保持良好的可读性。
- 页脚(Footer): 这部分用于引用与此次提交相关联的Issue或者Pull Request编号,例如:“Fixes #123”或“Closes #456”。页脚也是可选的,主要用于项目跟踪目的。
辅助用工具:
版本: 1.4.1
下载与安装:
idea plugin online store 搜索 Git Commit Message Helper 即可
用法:
- 在idea的commit页面中, 分别点击如图所示按钮,即可呼出commit helper页面。

- Type of Change 【必填】:
- feat:提交新功能
- fix:修复了bug
- docs:只修改了文档
- style:调整代码格式,未修改代码逻辑(比如修改空格、格式化、缺少分号等)
- refactor:代码重构,既没修复bug也没有添加新功能
- perf:性能优化,提高性能的代码更改
- test:添加或修改代码测试
- chore:对构建流程或辅助工具和依赖库(如文档生成等)的更改
- Scope of this change 【必填】:此处指的是此处提交影响的范围,你可以写具体的文件,也可以写影响的业务模块
- Short Description 【必填】:标题,简要描述这个提交做了什么,不要太长
- Long Description 【选填】: 正文, 如有必要的话, 这个是对标题的补充,具体描述内容,但是也尽可能不要太长
- Breaking Changes 【选填】: 如果这个修改是破坏性的,不向下兼容的话,填上说明
- Closed Issues 【选填】: 这个提交解决的Issues编号
- Skip CI 【选填】: 极其特殊的清空你需要skip CI的话, 勾上,但建议不选
发表回复