码农知识堂 - 1000bd
  •   Python
  •   PHP
  •   JS/TS
  •   JAVA
  •   C/C++
  •   C#
  •   GO
  •   Kotlin
  •   Swift
  • 规范 Git 提交说明


    Commit Message 的规范

    Commit Message 的规范主要包括以下几个部分:

    • Header:包括三个字段,分别是 type(必需,用于说明 commit 的类别)、scope(必需,说明 commit 影响的范围)和 subject(必需,是 commit 目的的简短描述,不超过50个字符,以动词开头,使用第一人称现在时,结尾不加句号)。
    • Body:是对本次 commit 的详细描述,可以分成多行,通常是对本次 commit 实现的详细功能、修复的 bug 等进行说明。

    此外,不管是 Header 还是 Body,任何一行都不得超过 72 个字符(或 100 个字符),以避免自动换行影响美观。

    一、Header

    1、type

    用于说明类型。可分以下几种类型

    feat新功能
    fix修复bug
    improvement对当前功能的改进
    docs仅包含文档的修改
    style格式化变动,不影响代码逻辑。比如:清除多余空白、删除分号等
    refactor重构,既不是新增功能,也不是修改bug的代码改动
    perf提高性能的修改
    test添加或修改测试代码
    build构建工具或外部依赖包的修改
    ci持续集成的配置文件或脚本的修改
    chore其他不修改源代码与测试代码的变动
    revert 版本回滚或撤销某次提交

    2、scope

    用于说明影响的范围,比如 views、component、utils 等等。

    3、subject

    主题,简短描述。一行

    二、Body

    对 subject 的补充。可以多行。

    使用 Commitizen

    Commitizen 是一个撰写符合上面 Commit Message 标准的一款工具。

    1、全局安装

    npm install -g commitizen cz-conventional-changelog

    2、创建 ~/.czrc 文件,写入如下内容

    { "path": "cz-conventional-changelog" }

    3、代码提交时使用 git cz 命令来代替 git commit 命令

  • 相关阅读:
    局域网基本概念和体系结构
    docker-compose 安装 loki+promtail+grafana
    机器学习(四十八):粒子群优化(PSO)-提升机器学习模型准确率的秘密武器
    【设计模式】28.结构型模式-桥接(Bridge)
    emlogPro实现模板预览功能(包含模板设置数据)
    Weblogic反序列化漏洞(CVE-2018-2628/CVE-2023-21839复现)
    城市智慧化发展的一部分:智慧公厕的前景
    Linux--进程控制
    基于SpringBoot的宠物领养网站管理系统
    python的列表
  • 原文地址:https://blog.csdn.net/liangshanbo1215/article/details/136330668
  • 最新文章
  • 攻防演习之三天拿下官网站群
    数据安全治理学习——前期安全规划和安全管理体系建设
    企业安全 | 企业内一次钓鱼演练准备过程
    内网渗透测试 | Kerberos协议及其部分攻击手法
    0day的产生 | 不懂代码的"代码审计"
    安装scrcpy-client模块av模块异常,环境问题解决方案
    leetcode hot100【LeetCode 279. 完全平方数】java实现
    OpenWrt下安装Mosquitto
    AnatoMask论文汇总
    【AI日记】24.11.01 LangChain、openai api和github copilot
  • 热门文章
  • 十款代码表白小特效 一个比一个浪漫 赶紧收藏起来吧!!!
    奉劝各位学弟学妹们,该打造你的技术影响力了!
    五年了,我在 CSDN 的两个一百万。
    Java俄罗斯方块,老程序员花了一个周末,连接中学年代!
    面试官都震惊,你这网络基础可以啊!
    你真的会用百度吗?我不信 — 那些不为人知的搜索引擎语法
    心情不好的时候,用 Python 画棵樱花树送给自己吧
    通宵一晚做出来的一款类似CS的第一人称射击游戏Demo!原来做游戏也不是很难,连憨憨学妹都学会了!
    13 万字 C 语言从入门到精通保姆级教程2021 年版
    10行代码集2000张美女图,Python爬虫120例,再上征途
Copyright © 2022 侵权请联系2656653265@qq.com    京ICP备2022015340号-1
正则表达式工具 cron表达式工具 密码生成工具

京公网安备 11010502049817号