目录
一、Commit message 的格式
1.1 Header
1.2 Body
二、例子
2.1 feat例子
2.2 fix例子
插件推荐
首页 Java java教程 Java Git Commit Message使用规范是什么

Java Git Commit Message使用规范是什么

May 11, 2023 am 09:46 AM
java git

    一、Commit message 的格式

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

    <type>(<scope>): <subject>
    // 空一行
    <body>
    登录后复制

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

    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.安装插件

    Java Git Commit Message使用规范是什么

     2.提交时选择插件提交

    Java Git Commit Message使用规范是什么

    Java Git Commit Message使用规范是什么

    以上是Java Git Commit Message使用规范是什么的详细内容。更多信息请关注PHP中文网其他相关文章!

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

    热AI工具

    Undresser.AI Undress

    Undresser.AI Undress

    人工智能驱动的应用程序,用于创建逼真的裸体照片

    AI Clothes Remover

    AI Clothes Remover

    用于从照片中去除衣服的在线人工智能工具。

    Undress AI Tool

    Undress AI Tool

    免费脱衣服图片

    Clothoff.io

    Clothoff.io

    AI脱衣机

    Video Face Swap

    Video Face Swap

    使用我们完全免费的人工智能换脸工具轻松在任何视频中换脸!

    热门文章

    <🎜>:泡泡胶模拟器无穷大 - 如何获取和使用皇家钥匙
    3 周前 By 尊渡假赌尊渡假赌尊渡假赌
    Mandragora:巫婆树的耳语 - 如何解锁抓钩
    3 周前 By 尊渡假赌尊渡假赌尊渡假赌
    北端:融合系统,解释
    3 周前 By 尊渡假赌尊渡假赌尊渡假赌

    热工具

    记事本++7.3.1

    记事本++7.3.1

    好用且免费的代码编辑器

    SublimeText3汉化版

    SublimeText3汉化版

    中文版,非常好用

    禅工作室 13.0.1

    禅工作室 13.0.1

    功能强大的PHP集成开发环境

    Dreamweaver CS6

    Dreamweaver CS6

    视觉化网页开发工具

    SublimeText3 Mac版

    SublimeText3 Mac版

    神级代码编辑软件(SublimeText3)

    热门话题

    Java教程
    1668
    14
    CakePHP 教程
    1426
    52
    Laravel 教程
    1329
    25
    PHP教程
    1273
    29
    C# 教程
    1256
    24
    币圈行情实时数据免费平台推荐前十名发布 币圈行情实时数据免费平台推荐前十名发布 Apr 22, 2025 am 08:12 AM

    适合新手的加密货币数据平台有CoinMarketCap和非小号。1. CoinMarketCap提供全球加密货币实时价格、市值、交易量排名,适合新手与基础分析需求。2. 非小号提供中文友好界面,适合中文用户快速筛选低风险潜力项目。

    git:版本控制的核心,github:社交编码 git:版本控制的核心,github:社交编码 Apr 23, 2025 am 12:04 AM

    Git和GitHub是现代软件开发的关键工具。 Git提供版本控制功能,通过仓库、分支、提交和合并管理代码。 GitHub则提供代码托管和协作功能,如Issues和PullRequests。使用Git和GitHub可以显着提升开发效率和团队协作能力。

    比特币成品结构分析图是啥?怎么画? 比特币成品结构分析图是啥?怎么画? Apr 21, 2025 pm 07:42 PM

    绘制比特币结构分析图的步骤包括:1. 确定绘图目的与受众,2. 选择合适的工具,3. 设计框架并填充核心组件,4. 参考现有模板。完整的步骤确保图表准确且易于理解。

    作曲家:通过AI的帮助开发PHP 作曲家:通过AI的帮助开发PHP Apr 29, 2025 am 12:27 AM

    AI可以帮助优化Composer的使用,具体方法包括:1.依赖管理优化:AI分析依赖关系,建议最佳版本组合,减少冲突。2.自动化代码生成:AI生成符合最佳实践的composer.json文件。3.代码质量提升:AI检测潜在问题,提供优化建议,提高代码质量。这些方法通过机器学习和自然语言处理技术实现,帮助开发者提高效率和代码质量。

    币圈前10大交易平台 加密货币正规交易平台前十(2025版) 币圈前10大交易平台 加密货币正规交易平台前十(2025版) Apr 21, 2025 pm 10:30 PM

    2025年币圈前10大正规加密货币交易平台预测为:1. Coinbase,2. Kraken,3. Gemini,4. 币安,5. 欧易,6. Bitstamp,7. LMAX Digital,8. Itbit,9. Coincheck,10. 芝麻开门,这些平台在合规性、安全性、用户体验等方面表现优异。

    在Java的背景下,'平台独立性”意味着什么? 在Java的背景下,'平台独立性”意味着什么? Apr 23, 2025 am 12:05 AM

    Java的平台独立性是指编写的代码可以在任何安装了JVM的平台上运行,无需修改。1)Java源代码编译成字节码,2)字节码由JVM解释执行,3)JVM提供内存管理和垃圾回收功能,确保程序在不同操作系统上运行。

    Galaxy Digital获得SEC批准纳斯达克列表和重组 Galaxy Digital获得SEC批准纳斯达克列表和重组 Apr 21, 2025 pm 02:45 PM

    GalaxyDigitalHoldings获得美国证券交易委员会(SEC)批准,正式启动重组计划!GalaxyDigital已获SEC批准,其纳斯达克上市及公司架构重组计划正式进入下一阶段。此消息于周一公布。SEC已批准GalaxyDigital的注册声明。此举是公司计划将公司结构从开曼群岛迁往特拉华州的关键步骤,并同时成立新母公司NewPubCo。GalaxyDigital首席执行官表示:“我们对注册声明生效感到兴奋,这标志着GalaxyDigital发展历程中的重要里程碑,将进一

    H5:HTML5的关键改进 H5:HTML5的关键改进 Apr 28, 2025 am 12:26 AM

    HTML5带来了五个关键改进:1.语义化标签提升了代码清晰度和SEO效果;2.多媒体支持简化了视频和音频嵌入;3.表单增强简化了验证;4.离线与本地存储提高了用户体验;5.画布与图形功能增强了网页的可视化效果。

    See all articles