从前慢现在也慢

这个屌丝很懒，什么也没留下！

热门标签

【软件开发规范篇】Git代码提交规范_后端代码提交规范

作者：从前慢现在也慢 | 2024-05-12 00:18:03

踩

后端代码提交规范

作者介绍：本人笔名姑苏老陈，从事JAVA开发工作十多年了，带过大学刚毕业的实习生，也带过技术团队。最近有个朋友的表弟，马上要大学毕业了，想从事JAVA开发工作，但不知道从何处入手。于是，产生了写一个博客专栏想法，介绍当前互联网企业JAVA项目开发如何快速入门。

本文收录于《30天企业JAVA项目开发实战入门》专栏，该专栏内容以当前互联网软件企业中的项目实战为线索，介绍企业JAVA项目开发中涉及到的开发流程、技术、工具、规范要求等等。帮助想从事JAVA开发的大学生或新人，更快的、更好的入门JAVA后端开发工作。

文章目录

一、前言

本文介绍软件项目开发过程中，代码提交到git仓库，建议遵循的一些规范。

每次提交代码到 Git 仓库时，都需要写 commit message。通常情况下，commit message 应该清晰明了，说明本次提交的目的和具体操作等。

然而，在日常开发中，开发者们提交的 commit message 千差万别，中英文混用，导致后续代码维护成本很高，有时候甚至自己都不知道修复的是什么问题。

因此，为了解决这些问题，建议大家在提交代码的时候，能遵循一些规范或约定，从而提高代码规范，提高开发效率。

二、Git代码提交规范

1、切忌一次大量提交代码；

2、每次 fix 或 feat 一个功能即需要提交到本地，可以不提交到远程；

3、提交代码前必须先拉代码；

4、一般情况下不得强制提交；

5、一个新功能拉取单独的分支开发，开发完后再合并到主分支上；

6、禁止无意义说明提交；

7、通常需要每天下班前推送本地仓库到远程仓库中；

8、Commit Log 都遵循一个精确的格式，以增加可读性，便于查看变更历史，并养成良好的 git 使用习惯；

三、Commit Log格式说明

Commit Log 包含三个部分：header、body、footer。其中，header 是必需的，包括types、scopes、subject，格式固定；body 非必填，在必要时用于详细解释变更。footer 非必填，可以填写需求原型链接，需求任务编号等；

commit log 格式如下：

<types>(<scopes>): <subject>

<空行>

<body>

<空行>

<footer>
1
2
3
4
5
6
7
8
9

示例如下：

feat(user): 开发我的订单功能

主要包括我的订单列表、查看订单详情等等

Closes 需求原型地址：https://www.baidu.com/
1
2
3
4
5

1、Type

英文，小写。必须是以下中的一个或多个：

feat: function小功能。注意：feat 改成 func 了，避免大家按 feature 这个大粒度来提交，期望是按小功能点分批提交，另外避免跟 feature 分支规范混淆。

fix: bug 修复，包括编码过程中的逻辑修复，不特指线上 bug 修复。

refactor: 重构代码，非 bug 修复和性能优化，包括编码过程中的代码结构调整，不特指重构项目。

impr: improvement，小的代码设计改进。

perf: 性能优化。

apm: 仅监控打点、异常日志处理相关。

chore: 无关紧要的改动，例如删除用不到的注解、调整日志内容等。

jvm: 仅 JVM 参数变更。

pom: 仅依赖和版本变化。

conf: 仅配置变化，Spring 配置、properties 文件。

docs: 仅文档变更。

style: 代码格式调整，如 import 清理，代码格式化。

test: 单测和自动化 case 相关。

typo: 修复小的拼写错误。

wip: work in progress，少用，用于开发中的不完整提交，新工程开始时偶尔使用。

2、Scope

英文，小写。表示变更的包或模块范围，可以是多个组合，如果涉及范围较大，可以用 * 代替。各服务可以自行定义，组内同学可以轻易理解。

例如，以下是商城平台中定义的字段：

user:用户相关， price: 价格相关。 stock: 库存相关。 goods: 商品相关。 order: 订单相关。

3、Subject

中文。简要描述修改的内容，不要超过100个字。

4、Body

中文。详细描述修改的内容，不要超过500字；

5、Footer
中文。可以放置需求 wiki 或 task 链接。

四、使用插件生成Commit Log格式

在开发工具中，安装Git Commit Template 插件，生成commit log。如图：

在这里插入图片描述

安装完成后，界面上出显示一个小图标，用于“create commit message”；

在这里插入图片描述

点击小图标后，出现如下弹窗

在这里插入图片描述

之后，我们填写对应的内容，点击OK后，就会自动生成规范的commit log格式。注意，前面三项是必须填写的内容。

在这里插入图片描述

如果您对文章中内容有疑问，欢迎在评论区进行留言，我会尽量抽时间给您回复。如果文章对您有帮助，欢迎点赞、收藏。您的点赞，是对我最大的支持和鼓励，谢谢 :-）

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/从前慢现在也慢/article/detail/556797