Java中Git代码提交规范

已于 2022-11-24 11:34:03 修改
阅读量1.2k 收藏 2
点赞数
分类专栏： Git 文章标签： git 代码规范 java
于 2022-11-18 10:24:21 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_41473691/article/details/127916539
版权

今天在写项目，提交代码时发现，别人在提交代码时总要加上一些前缀比如Fix:优化细节。便去了解一下，收获一个小细节。

文章目录

概述

每当完成一个功能、或修改了一个bug、调整格式、重构模块的时候，都应该commit一次代码，以便git记录这次修改。

规定：在提交时不能将不相关的修改一块提交，比如：配置文件，自己在本地做的修改等与这次提交内容无关的文件。

代码提交格式

<type>:<subject>
//空行
<body>

type

  • 用于说明本次提交类型
  • feat:新增功能
  • fix:修复bug
  • docs:修改文档，readme.md等
  • test：增加测试用例，包括单元测试，集成测试等。
  • style：修改了空行、索引个数、引用包排序等。
  • perf：优化相关内容，性能提升、体验等
  • refactor:代码重构，没有新功能或者修复bug
  • chore：改变构建流程，或新增依赖库、工具等。
  • revert：回滚上一个版本
  • merge：代码合并

subject

是commit目的的简短描述不超过50-80个字符，subject之前有一个空格，在浏览有很多消息的历史记录是，多个空格，更方便阅读。

body

对本次提交的详细描述，可分多行
body之前有一个空行，为了浏览日志中只显示提交的简要说明。
如果type是fix修复错误，必须在body中记录一下信息：重新错误的步骤；预期应有的行为，观察到的错误行为，那当提交的说明已经能说明时，body部分就可以省略。

提交举例

在这里插入图片描述
在这里插入图片描述

有任何想要讨论和学习的问题可联系我：577371067@qq.com 不足之处请大家指正。

小白在哪呢
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
专栏目录
oo-basic-step-by-step-example-java:Java面向对象练习
05-01
Java面向对象编程 练习描述 根据测试目录下各包下README.md中的需求编写代码，使得测试代码可以运行通过。 环境要求 Java 8 Intellij-IDEA 如何开始 在命令行中使用以下命令在用户本地任意目录下clone此题目库 git clone repo_of_this_template 运行测试： ./gradlew test 输出规范 根据src/test/java/paractice_/README.md完成对应的src/main/java/practice_/的代码。要求测试通过，并符合题目要求。 能够理解代码的执行过程中都发生了什么，如果不能够理解，使用调试器进行单步调试来辅助理解。 每完成一个练习至少提交一次代码。 反注释测试代码以执行。
java-oo-practice
05-02
#Java OO 练习描述 根据测试目录下各包下README.md中的需求编写代码，使得测试代码可以运行通过。 环境要求 Java 8 Intellij-IDEA 如何开始 在命令行中使用以下命令在用户本地任意目录下clone此题目库 git clone repo_of_this_template 运行测试： ./gradlew test 输出规范 根据src/test/java/paractice_/README.md完成对应的src/main/java/practice_/的代码。要求测试通过，并符合题目要求。 能够理解代码的执行过程中都发生了什么，如果不能够理解，使用调试器进行单步调试来辅助理解。 每完成一个练习至少提交一次代码。 反注释测试代码以执行。
【软件开发规范篇】Git代码提交规范
最新发布
分享是一种境界，勤于分享，乐于分享！
04-28 1451
本文介绍软件项目开发过程中，代码提交到git仓库，建议遵循的一些规范。每次提交代码到 Git 仓库时，都需要写 commit message。通常情况下，commit message 应该清晰明了，说明本次提交的目的和具体操作等。然而，在日常开发中，开发者们提交的 commit message 千差万别，中英文混用，导致后续代码维护成本很高，有时候甚至自己都不知道修复的是什么问题。因此，为了解决这些问题，建议大家在提交代码的时候，能遵循一些规范或约定，从而提高代码规范，提高开发效率。
gitlab 服务器端代码格式以及git提交信息格式检查钩子文件，可以拿来直接使用
09-15
gitlab 服务器端代码格式以及git提交信息格式检查钩子文件，可以拿来直接使用，匹配的阿里p3c代码规范检查插件，已经打包好，可以直接下载：https://download.csdn.net/download/TangKai_java/86539113
gerrit:Gerrit代码审查-（https的镜像
03-16
Gerrit代码审查 是用于基于Git的项目的代码审查和项目管理工具。 客观的 Gerrit通过并排显示更改，并允许任何审阅者添加内嵌评论，使审阅更加容易。 Gerrit允许任何授权用户向Git主存储库提交更改，从而简化了基于Git的项目维护，而不是要求所有已批准的更改由项目维护者手动合并。 文献资料 有关如何安装和使用Gerrit的信息，请参阅。 来源 我们规范的Git存储库位于。 上有一个仓库的镜像。 报告错误 请报告错误。 贡献 Gerrit是数百位贡献者的作品。 感谢您的帮助！ 请阅读。 请注意，我们不通过Github镜像接受拉取请求。 取得联系 开发者邮件列表是。 执照 Gerrit是根据Apache License 2.0提供的。 建造 安装并运行以下命令： git clone --recurse-submodules https://gerrit.googles
beiyinmei:贝因美电商项目
05-13
qm-kstore 欢迎进入私有云项目 分支说明： 1: master: 产品主干代码 2: kstore-product-dev: 产品开发分支 3: kstore-market 应用市场的代码，需要karaf环境，方可运行。不要将这个分支合并到主干分支上。 主干提交规范 1:master为标准产品代码， 主干master代码不允许提交。如果需要增加产品增能,只要完成测试，达到上线标准就可以pull requests,由组长审核代码 2:提交必须标明注释，修改bug需注明； 定制项目建立规范 1:定制项目位于groups： qm-kstore-dev 2:各自创建项目，名称规范： 分支名称由定制的项目名称+时间组成 git提交基本规范 1:要求：提交代码前，先从服务器更新代码。确保解决所有冲突并编译通过后再提交代码。 2:要求：提交代码时，需要采用原子提交的方式进行提交。（原子提交指：任
实现提交代码至 Git 远程仓库前，自动验证规范性
Lyrelion的博客
05-19 3875
实现提交代码至 Git 远程仓库前，自动验证规范性
git commit规范
qq_52031408的博客
05-28 1049
git commit规范
JAVA 后台开发规范
on the way . . .
09-21 996
本篇规范基于阿里巴巴、华为的开发手册。感谢前人的经验和付出，让我们可以有机会站在巨人的肩膀上眺望星辰大海。 规范不是为了约束和禁锢大家的创造力，而是为了帮助大家能够在正确的道路上，尽可能的避免踩坑和跑偏。 规范可以让我们无论单枪匹马还是与众人同行的时候都能得心应手。 规范可以让我们在面对日益变态的需求和做代码接盘侠的时候，更优雅从容。 规则并不是完美的，通过约束和禁止在特定情况下的特性，可能会对代码实现造成影响。 但是制定规则的目的：为了得到更多的好处，如果在团队实际运作中认为某个规则无法遵循或有更好的..
整理最全规范之Git仓库管理规范，Java开发规范，最全Java命名规范，数据库开发设计规范，接口设计规范
爱是与世界平行
10-12 5432
一、代码仓库创建规范 1、 项目创建需符合Group规范。 2、 创建项目必须添加Project description说明。 3、 每个项目都需要README.md文件。 4、 除文档说明类型仓库，所有代码仓库都需要.gitignore。 注：有模板的项目，要以统一的模板创建项目 1.1 README文件规范 README文件结构如下： <项目简介/Introduction> <快速使用/Quick start> <文档说明/Documentation> Intro
Java后端开发常用规范
IT利刃出鞘的博客
08-08 5634
本文介绍Java后端开发的一些规范。持续更新。 本规范是本人总结出来的，可提高项目的可维护性、提高扩展性、提高开发速度。本文可以解决项目中效率低下、难以维护、让人心累的痛点等问题。
【Java代码规范】阿里编码规约 VS CheckStyle
c_zyer的博客
09-09 1059
常见的规范扫描工具：**阿里编码规约扫描**、**checkStyle**，今天主要描述这两个工具如何在日常编码过程中使用，以及如何与git配合来规范代码的提交。阿里编码规约IDE插件、CheckStyle IDE插件、阿里编码规约和CheckStyle配置git precommit check
如何规范Git提交-参考阿里云开发者社区
我亦无他，唯手熟尔
02-01 1741
编码规范、流程规范在软件开发过程中是至关重要的，它可以使我们在开发过程中少走很多弯路。Git commit规范也是如此，确实也是很有必要的，几乎不花费额外精力和时间，但在之后查找问题的效率却很高。作为一名程序员，我们更应注重代码和流程的规范性，永远不要在质量上将就。
Java -- git 上传项目问题
sky_eyeland的博客
12-17 123
Java -- git 上传项目问题
JAVA代码规范
whatareyouding的专栏
03-31 573
1. 命名规范 1.1 总体命名规则 1. 名字含义要明确，做到见名知义,如: User，Customer 2. 尽量少用缩写，必须确保能让人看懂含义。 1.2 变量名 1. 小驼峰式命名，变量名首字母必须为小写字母，不使用 “_” 作为变量名(包括成员变量)开头 2. 尽量使用英文作为变量名， 若使用汉语拼音，必须注释清楚 3. 正确：userName 错误：UserName
Java项目代码规范
且将&的博客
03-03 150
java项目代码规范学习整理
Git Commit 规范
暮年雨影的博客
08-31 366
Git Commit 规范
ACM基础——OJ上的Java代码提交规范
追求卓越的攻城狮
07-24 7080
1、输入 Scanner cin = new Scanner(System.in); while(cin.hasNext()){ int a = cin.nextInt(); int b = cin.nextInt(); } 2、类名 public class Main {}
我为公司制定的Java代码规范
rain的专栏
07-01 3303
http://sulong.me/2009/06/05/code_standard Java代码规范 本Java代码规范以SUN的标准Java代码规范为基础，为适应我们公司的实际需要，可能会做一些修改。本文档中没有说明的地方，请参看SUN Java标准代码规范。如果两边有冲突，以本文档为准。 1. 标识符命名规范 1.1 概述 标识符的命名力求
java代码版本管规范
10-23
5. 版本控制规范：规定代码提交、分支管理、合并策略、代码回滚等版本控制操作的规范，确保代码提交的可追溯性和安全性。 6. 异常处理规范：明确规定异常处理的方式和原则，例如在方法声明时指明可能抛出的异常类型...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值