iis服务器助手广告广告
返回顶部
首页 > 资讯 > 后端开发 > Python >Java Git Commit Message使用规范
  • 392
分享到

Java Git Commit Message使用规范

2024-04-02 19:04:59 392人浏览 安东尼

Python 官方文档:入门教程 => 点击学习

摘要

目录概述一、Commit message 的格式1.1 Header1.2 Body二、例子2.1 feat例子2.2 fix例子插件推荐概述 不知道大家在各自项目中是如何写提供代码

概述

不知道大家在各自项目中是如何写提供代码的commit message, 我们项目有的同事写的很简单,压根不知道提交了什么内容,是新功能还是缺陷修复。本质上 commit message就是为了让团队成员知道这次提交的内容,为此,我们出了一个规范,约定团队的每个同事按照这个规范提交代码,达到通过message能够了解此次修改的内容。

一、Commit message 的格式

每次提交,Commit message 都包括三个部分:Header,Body 和 Footer。

<type>(<scope>): <subject>
// 空一行
<body>

其中,Header、针对feat和fix类型的提交内容 Body 是必需的。 不管是哪一个部分,任何一行都不得超过72个字符(或100个字符)。这是为了避免自动换行影响美观。

1.1 Header

Header部分只有一行,包括三个字段: type(必需)、scope(必需)和subject(必需)。
(1)type
type用于说明 commit 的类别,只允许使用下面7个标识。

  • feat:新功能(feature)
  • fix:修补bug
  • docs:文档(documentation)
  • style: 格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • test:增加测试
  • build:构建过程或辅助工具的变动

(2)scope
scope用于说明 commit 影响的范围,比如指标模板、规则上下线等等,视项目不同而不同。
(3)subject
subject是 commit 目的的简短描述,不超过50个字符。

  • 1. 以动词开头,使用第一人称现在时,比如change,而不是changed或changes
  • 2. 第一个字母小写
  • 3. 结尾不加句号(.)

1.2 Body

Body 部分是对本次 commit 的详细描述,可以分成多行。

  • 1. 需要简要的列出各种正向或者反向的测试场景,测试通过,填pass。
  • 2. 增加修改人信息

二、例子

2.1 feat例子

feat(规则上下线、构建、生效、仿真生效): 添加规则上下线功能 

1. 规则上下线主流程,引擎正常订阅,fldl生成正常。 pass
2. 规则上下线,传入不存在的规则编号,异常提示。 pass

提交人:xxx

2.2 fix例子

fix(模型模块): 模型测试失败

1. 导入mar模型,包含衍生字段。 pass
2. 导入mar模型,不包含衍生字段。 pass

提交人:xxx

插件推荐

idea可以安装代码提交规范的插件。

1.安装插件

 2.提交时选择插件提交

到此这篇关于Java git Commit Message使用规范的文章就介绍到这了,更多相关Java Git Commit Message内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!

--结束END--

本文标题: Java Git Commit Message使用规范

本文链接: https://www.lsjlt.com/news/166185.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • Java Git Commit Message使用规范
    目录概述一、Commit message 的格式1.1 Header1.2 Body二、例子2.1 feat例子2.2 fix例子插件推荐概述 不知道大家在各自项目中是如何写提供代码...
    99+
    2024-04-02
  • git commit规范的有哪些
    本篇内容介绍了“git commit规范的有哪些”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!为什么要规范...
    99+
    2024-04-02
  • js前端架构Git commit提交规范
    目录Git commit 规范为什么要写好 Git Commit如何写好Git Commit利用插件(commitizen)Git hooks客户端 Hooks服务端 Hooks项目...
    99+
    2024-04-02
  • Git 使用规范有哪些
    本篇文章为大家展示了Git 使用规范有哪些,内容简明扼要并且容易理解,绝对能使你眼前一亮,通过这篇文章的详细介绍希望你能有所收获。第一步:新建分支首先,每次开发新功能,都应该新建一个单独的分支(这方面可以参考《Git分支管理策略》)。# 获...
    99+
    2023-06-04
  • git commit怎么使用
    要使用git commit命令,您需要按照以下步骤进行操作:1. 在终端或命令行中导航到您的git仓库目录。2. 使用git add...
    99+
    2023-08-15
    git commit
  • Git的使用规范:如何避免代码冲突?
    Git是一款广泛使用的版本控制系统,它可以帮助团队协作开发,以及管理代码的版本。但是,当多个人同时修改同一个文件时,就有可能发生代码冲突的情况。本文将介绍Git的使用规范,以及如何避免代码冲突。 1. Git分支管理 Git的分支管理功能可...
    99+
    2023-10-15
    编程算法 javascript git
  • Git操作规范之tag的使用技巧详解
    目录常用分支masterdevelopreleasehotfix使用注意tag规范打tag场景tag命名规范版本类型说明版本号设置规范场景举例新需求修复bug重大版本更新特殊情况常用...
    99+
    2024-04-02
  • idea中git如何修改commit(ChangeList的使用)
    目录1. 取消指定提交2. 创建ChangeList3. 重新提交进阶创建ChangeList代码转移ChangeList 提交总结有时候我们需要修改已经提交的commit(在本地缓...
    99+
    2023-05-14
    idea git git修改commit ChangeList的使用
  • 关于MySQL的使用规范
    这篇文章主要介绍关于MySQL的使用规范,文中介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们一定要看完!最近涉及数据库相关操作较多,公司现有规范也不是太全面,就根据网上各路大神的相关规范,整理了一些自...
    99+
    2024-04-02
  • MySQL使用规范有哪些
    本篇内容介绍了“MySQL使用规范有哪些”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!数据库环境dev: ...
    99+
    2024-04-02
  • ASP.NET Core使用Swagger/OpenAPI规范
    目录1.什么是Swagger/OpenAPI?2.NET Swagger实现3.Swashbuckle主要组成部分4.什么是REST5.配置Swagger中间件6.XML注释7.数据...
    99+
    2024-04-02
  • Gitlab学习之企业常用的一些git规范
    俗话说,没有规矩不成方圆,我们的git也需要规范。下面介绍一下企业常用的一些规范。分支管理规范分支命名不能千奇百怪,必须有统一的命名方式。主要有以下几种:分支管理命名规范解释master 主分支master稳定版本分支,上线完成回归后后,由...
    99+
    2023-10-22
    Git GitHub GitLab
  • MySQL数据库的使用规范
    这篇文章给大家分享的是有关MySQL数据库的使用规范的内容。小编觉得挺实用的,因此分享给大家做个参考。一起跟随小编过来看看吧。一个平台或系统随着时间的推移和用户量的增多,数据库操作往往会变慢;而在Java应...
    99+
    2024-04-02
  • JSONschema配置规范使用教程
    目录介绍使用schemastore编写 schemapropertiesdefinitions总结介绍 不知道大家在写一些 JSON 配置时会不会经常觉得麻烦,每次都要打开文档去核对...
    99+
    2022-11-13
    JSON schema配置规范 JSON schema
  • @Valid注解怎么规范使用
    这篇文章主要介绍“@Valid注解怎么规范使用”的相关知识,小编通过实际案例向大家展示操作过程,操作方法简单快捷,实用性强,希望这篇“@Valid注解怎么规范使用”文章能帮助大家解决问题。@Valid注解大全及用法规范注解描述@Assert...
    99+
    2023-06-29
  • java代码规范的作用是什么
    java代码规范的作用是什么,针对这个问题,这篇文章详细介绍了相对应的分析和解答,希望可以帮助更多想解决这个问题的小伙伴找到更简单易行的方法。代码规范有什么意义1.一个软件的生命周期中,80%的花费在于维护,代码规范降低了金钱成本和时间成本...
    99+
    2023-06-02
  • mysql timestamp字段规范使用详情
    目录1. 前言2. mysql中的时间字段2.1. 数据的存储方式2.2. DATETIME和TIMESTMAP的区别3. timestamp字段处理默认值和null值时的...
    99+
    2024-04-02
  • 关于注解FeignClient的使用规范
    注解FeignClient使用规范 首先是对FeignClient里的常用属性 contextId:当有多个服务调用方法不想写在一个接口里,就要使用到name:指定FeignClie...
    99+
    2024-04-02
  • States字段使用规范有哪些
    States字段使用规范有哪些,很多新手对此不是很清楚,为了帮助大家解决这个难题,下面小编将为大家详细讲解,有这方面需求的人可以来学习下,希望你能有所收获。解决方式States对应位域枚举StatesFla...
    99+
    2024-04-02
  • CSS如何使用BEM命名规范
    这篇文章将为大家详细讲解有关CSS如何使用BEM命名规范,小编觉得挺实用的,因此分享给大家做个参考,希望大家阅读完这篇文章后可以有所收获。BEM(块,元素,修饰符)是基于组件的Web开发的一种前端命名方法论,主要针对CSS。其背后的想法是将...
    99+
    2023-06-08
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作