项目场景:
在项目开发中,很多项目都是使用git作为代码版本管理工具。作为团队协作,git提交规范,不仅有助于我们查找问题的原因,还有理解代码的操作,提高开发效率。
问题描述
在项目开发中,经常会有团队成员提交代码时备注------、优化、修改bug等等字样,让后续开发过程中发现问题,寻找原因时,提高排查的难度。
原因分析:
主要原因是没有规范git代码的提交。以下是常用的git操作类型:
feat: 新增功能
fix: 修改功能。日常bug修复,文档修改
docs: 文档的改动。如vue开发中,有readme.md文档,会有一些常用的操作方法和公共方法说明,当其改动时,可以备注中标签
style: 代码风格的调整。如对代码进行格式化,或者缩进空格,换行等
解决方案:
在项目开发中,需要明确开发的规范。以下是常用的一些规范:
1、每个字段提交必须使用标签前缀。如修改代码时用,fix: 修改代码;新增代码时,用 feat: 新增xxx功能。
2、修改文档时,使用docs:备注说明。
3、格式化代码时,使用 style: 代码格式化
常用的主要是这三种规范,可以在一定程度上对代码提交进行规范,减少问题排查的难度,找到原始记录。