Git 提交规范是指在提交代码时,按照一定的格式来描述提交内容的方式。这样可以使团队成员更好地理解每次提交的变化和意图,从而提高协作效率和代码质量。
常见的 Git 提交规范包括以下几个部分:
- 类型(type):表示本次提交的类型,通常包括以下几种:
- feat:新功能(feature)
- fix:修复 bug
- docs:文档更新
- style:代码格式调整,不涉及功能修改(例如空格、缩进等)
- refactor:重构代码,既不增加新功能也不修复 bug
- test:添加或修改测试用例
- chore:对构建过程或辅助工具进行修改
范围(scope):表示本次提交影响的范围。例如可以是某个模块、某个页面或者某个函数等。
标题(title):简要描述本次提交的主要内容。
内容(body):详细描述本次提交所做的工作及其原因。
关闭问题(closed issues):如果该次提交解决了某个 issue,则在此处添加相应的 issue 编号,并使用关键字“close”、“closes”、“closed” 或者“fixes”。
重点变化(important changes):列出与以前版本不兼容的重大变化。
一个完整的 Git 提交信息示例如下:
feat(moduleA): 添加了新功能
- 在模块 A 中添加了一个新功能,可以实现 xxx 功能
- 该功能基于 xx 库实现,并对其进行了一定的封装和优化
closed #1234, closed #5678
重点变化:
- 修改了某些函数的参数类型
其中,“feat”表示本次提交为新功能,范围为“moduleA”,标题为“添加了新功能”。内容部分详细描述了新增功能及其实现方式。在关闭问题部分,则标明了该次提交解决了两个 issue。最后列出重要变化,方便其他开发者快速查看主要修改。
注意:Git 提交规范并不是强制性要求,而是一种推荐做法。具体应用时可根据自己或团队的需求和习惯进行调整。