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

本文为JAVA开发新手提供入门指引,重点讲解了企业项目开发中的Git代码提交规范,包括CommitLog的结构与编写规则,以及如何使用插件生成规范格式,以降低代码维护成本和提高开发效率。
摘要由CSDN通过智能技术生成

作者介绍:本人笔名姑苏老陈,从事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>

示例如下:

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

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

Closes 需求原型地址:https://www.baidu.com/

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格式。注意,前面三项是必须填写的内容。

在这里插入图片描述

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

### IntelliJ IDEA 中的 Git 提交指南 在 IntelliJ IDEA 中执行 Git 提交操作是一个直观的过程,该过程不仅简化了版本控制的任务还提高了开发效率。 #### 准备提交更改 为了准备提交,在 IDE 的右下角可以找到Git图标,点击它会打开一个弹窗显示当前分支的状态以及是否有未提交的变更。如果有文件被修改过,则这些文件会被列出来等待处理[^2]。 #### 查看差异与暂存文件 对于每一个已修改但还未加入到暂存区中的文件,可以通过双击列表里的条目来查看具体的改动详情。这有助于确认哪些部分已经被更新并决定是否要将此文件添加至即将提交的内容之中。一旦决定了想要包含在这个提交内的所有文件之后,选中它们并通过点击界面上方工具栏中的 “+” 按钮将其标记为“Staged”。 #### 编写有意义的日志消息 当所有的变动都被正确地放置到了暂存区域后,就可以编写一条描述性的日志信息了。一个好的做法是在输入框里使用简洁而清晰的语言概括本次提交的主要目的或修复的问题,并且如果适用的话还可以附加一些表情符号以增强表达效果[^1]。 ```bash git commit -m "✨ Add new feature to improve user experience" ``` #### 自动化检查风格一致性 为了避免不符合编码标准的情况发生,在实际推送之前最好先运行一次静态分析器来进行全面扫描。通常可以在项目的根目录设置好相应的配置文件(比如Checkstyle),再配合IDE内置功能或是通过安装额外插件的方式实现自动化检测机制。每当有新的commit动作触发时都会自动调用预先设定好的脚本完成这项工作[^3]。 #### 调整内存参数优化性能表现 有时为了让应用程序能够更流畅地运作起来可能需要调整JVM启动选项下的各项数值大小。例如针对IntelliJ本身而言便可通过编辑`idea64.exe.vmoptions`这个文件里面的相关字段达到改变初始堆空间(-Xms)、最大可用堆空间(-Xmx),还有预留代码缓存容量(–XX:ReservedCodeCacheSize)的目的从而改善整体响应速度和稳定性[^4]。
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

姑苏老陈

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值