zoukankan      html  css  js  c++  java
  • git commit 提交规范

    更多文章

    <type>(<scope>): <subject>
    <BLANK LINE>
    <body>
    <BLANK LINE>
    <footer>
    

    大致分为三个部分(使用空行分割):

    1. 标题行: 必填, 描述主要修改类型和内容
    2. 主题内容: 描述为什么修改, 做了什么样的修改, 以及开发的思路等等
    3. 页脚注释: 放 Breaking Changes 或 Closed Issues

    type: commit 的类型

    • init: 初始化
    • feat: 新特性
    • fix: 修改问题
    • refactor: 代码重构
    • docs: 文档修改
    • style: 代码格式修改, 注意不是 css 修改
    • test: 测试用例修改
    • build: 构建项目
    • chore: 其他修改, 比如依赖管理
    • scope: commit 影响的范围, 比如: route, component, utils, build...
    • subject: commit 的概述

    body: commit 具体修改内容, 可以分为多行.

    示例

    fix(修复BUG)

    如果修复的这个BUG只影响当前修改的文件,可不加范围。如果影响的范围比较大,要加上范围描述。

    例如这次 BUG 修复影响到全局,可以加个 global。如果影响的是某个目录或某个功能,可以加上该目录的路径,或者对应的功能名称。

    // 示例1
    fix(global):修复checkbox不能复选的问题
    // 示例2 下面圆括号里的 common 为通用管理的名称
    fix(common): 修复字体过小的BUG,将通用管理下所有页面的默认字体大小修改为 14px
    // 示例3
    fix: value.length -> values.length
    

    feat(添加新功能或新页面)

    feat: 添加网站主页静态页面
    
    这是一个示例,假设对页面内容进行了一些描述。
     
    这里是备注,可以是放BUG链接或者一些重要性的东西。
    

    chore(其他修改)

    chore 的中文翻译为日常事务、例行工作,顾名思义,即不在其他 commit 类型中的修改,都可以用 chore 表示。

    chore: 将表格中的查看详情改为详情
    

    其他类型的 commit 和上面三个示例差不多,在此不再叙述。

  • 相关阅读:
    01 变量、基本数据类型
    02 gitlab的基本使用
    kubernetes
    02 redis高可用集群
    Redis & ELK
    01 Redis安装、配置详解、数据备份与恢复
    Jenkins
    01 git gitlab jenkins的安装
    golang mysql 客户端
    接口类
  • 原文地址:https://www.cnblogs.com/woai3c/p/11800312.html
Copyright © 2011-2022 走看看