0

0

Java Git Commit Message使用规范是什么

WBOY

WBOY

发布时间:2023-05-11 09:46:05

|

1797人浏览过

|

来源于亿速云

转载

    一、Commit message 的格式

    每次提交,commit message 都包括三个部分:header,body 和 footer。

    (): 
    // 空一行
    

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

    1.1 Header

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

    • feat:新功能(feature)

    • fix:修补bug

      立即学习Java免费学习笔记(深入)”;

    • docs:文档(documentation)

    • style: 格式(不影响代码运行的变动)

    • refactor:重构(即不是新增功能,也不是修改bug的代码变动)

    • test:增加测试

    • build:构建过程或辅助工具的变动

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

    • 1. 以动词开头,使用第一人称现在时,比如change,而不是changed或changes

    • 2. 第一个字母小写

    • 3. 结尾不加句号(.)

      Question AI
      Question AI

      一款基于大模型的免费的AI问答助手、总结器、AI搜索引擎

      下载

    1.2 Body

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

    • 1. 需要简要的列出各种正向或者反向的测试场景,测试通过,填pass。

    • 2. 增加修改人信息

    二、例子

    2.1 feat例子

    feat(规则上下线、构建、生效、仿真生效): 添加规则上下线功能 1. 规则上下线主流程,引擎正常订阅,fldl生成正常。 pass2. 规则上下线,传入不存在的规则编号,异常提示。 pass提交人:xxx

    2.2 fix例子

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

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

    提交人:xxx

    插件推荐

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

    1.安装插件

    Java Git Commit Message使用规范是什么

     2.提交时选择插件提交

    Java Git Commit Message使用规范是什么

    Java Git Commit Message使用规范是什么

    相关文章

    java速学教程(入门到精通)
    java速学教程(入门到精通)

    java怎么学习?java怎么入门?java在哪学?java怎么学才快?不用担心,这里为大家提供了java速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

    下载

    相关标签:

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

    相关专题

    更多
    高德地图升级方法汇总
    高德地图升级方法汇总

    本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

    4

    2026.01.16

    全民K歌得高分教程大全
    全民K歌得高分教程大全

    本专题整合了全民K歌得高分技巧汇总,阅读专题下面的文章了解更多详细内容。

    3

    2026.01.16

    C++ 单元测试与代码质量保障
    C++ 单元测试与代码质量保障

    本专题系统讲解 C++ 在单元测试与代码质量保障方面的实战方法,包括测试驱动开发理念、Google Test/Google Mock 的使用、测试用例设计、边界条件验证、持续集成中的自动化测试流程,以及常见代码质量问题的发现与修复。通过工程化示例,帮助开发者建立 可测试、可维护、高质量的 C++ 项目体系。

    10

    2026.01.16

    java数据库连接教程大全
    java数据库连接教程大全

    本专题整合了java数据库连接相关教程,阅读专题下面的文章了解更多详细内容。

    33

    2026.01.15

    Java音频处理教程汇总
    Java音频处理教程汇总

    本专题整合了java音频处理教程大全,阅读专题下面的文章了解更多详细内容。

    15

    2026.01.15

    windows查看wifi密码教程大全
    windows查看wifi密码教程大全

    本专题整合了windows查看wifi密码教程大全,阅读专题下面的文章了解更多详细内容。

    42

    2026.01.15

    浏览器缓存清理方法汇总
    浏览器缓存清理方法汇总

    本专题整合了浏览器缓存清理教程汇总,阅读专题下面的文章了解更多详细内容。

    7

    2026.01.15

    ps图片相关教程汇总
    ps图片相关教程汇总

    本专题整合了ps图片设置相关教程合集,阅读专题下面的文章了解更多详细内容。

    9

    2026.01.15

    ppt一键生成相关合集
    ppt一键生成相关合集

    本专题整合了ppt一键生成相关教程汇总,阅读专题下面的的文章了解更多详细内容。

    6

    2026.01.15

    热门下载

    更多
    网站特效
    /
    网站源码
    /
    网站素材
    /
    前端模板

    精品课程

    更多
    相关推荐
    /
    热门推荐
    /
    最新课程
    Kotlin 教程
    Kotlin 教程

    共23课时 | 2.6万人学习

    C# 教程
    C# 教程

    共94课时 | 6.8万人学习

    Java 教程
    Java 教程

    共578课时 | 46.6万人学习

    关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
    php中文网:公益在线php培训,帮助PHP学习者快速成长!
    关注服务号 技术交流群
    PHP中文网订阅号
    每天精选资源文章推送

    Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号