iis服务器助手广告广告
返回顶部
首页 > 资讯 > 前端开发 > html >如何写Commit记录
  • 802
分享到

如何写Commit记录

2024-04-02 19:04:59 802人浏览 八月长安
摘要

本篇内容主要讲解“如何写Commit记录”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“如何写Commit记录”吧!安装插件在idea的Marketplace中,

本篇内容主要讲解“如何写Commit记录”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“如何写Commit记录”吧!

安装插件

idea的Marketplace中,搜索git Commit Template,就可以安装这个插件。插件很小,很快就能下载下来。

如何写Commit记录

正常从IDEA提交代码的时候。我们发现多了一个小按钮。

如何写Commit记录

点击之后,将弹出一个窗口。让你去设计提交模板。

如何写Commit记录

这么多信息,真的让人头晕。怪不得程序员们都不喜欢写提交记录。

其实,在插件的安装界面,就已经说明了这个提交记录的格式。

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

从描述中,可以肯容易的看到一个提交记录中,应该包含哪些东西。其中类型最多的,当然是提交类型。

提交类型Type

我们按照插件显示的顺序来说明一下。

  • feat 功能feature的意思,也是最常用的。当你的功能有变更的时候,都可以采用这种类型的type

  • fix 当然指的是bug修复

  • docs 更新了文档,或者更新了注释

  • style 代码格式调整,比如执行了fORMat、更改了tab显示等

  • refactor 重构代码。指的是代码结构的调整,比如使用了一些设计模式重新组织了代码

  • perf 对项目或者模块进行了性能优化。比如一些JVM的参数改动,把stringbuffer改为stringbuilder等

  • test 这个简单,就是增加了单元测试自动化相关的代码

  • build 影响编译的一些更改,比如更改了Maven插件、增加了npm的过程等

  • ci 持续集成方面的更改。现在有些build系统喜欢把ci功能使用yml描述。如有这种更改,建议使用ci

  • chore 其他改动。比如一些注释修改或者文件清理。不影响src和test代码文件的,都可以放在这里

  • revert 回滚了一些前面的代码

除了这些预设的,团队还可以按照自己的需求,增加新的type。比如专门处理线上工单,就可以创造一个叫做ticket的类型。

范围scope

scope是范围的意思,主要指的是代码的影响面。scope并没有要求强制,但团队可以按照自己的理解进行设计。通常由技术维度和业务维度两种划分方式。比如按照技术分为:controller、dto、service、dao等。但因为一个功能提交,会涉及到多个scope(都不喜欢非常细粒度的提交),所以按照技术维度分的情况比较少。

按照业务模块进行划分,也是比较不错的选择。比如分为user、order等划分,可以很容易看出是影响用户模块还是order模块。

如果你实在不知道怎么填,那就留空。

其他

主题subject

这个体现的是总结概括能力,没得跑。一句话能够说明主要的提交是什么。subject也是众多git管理工具默认显示的一行。如果你写的标准,那么提交记录看起来就很漂亮很规整。

正文Body

主要填写详细的改动记录。我一般习惯列上1234,但如果你的subject写的非常好,正文可以直接弱化。但如果时间充裕,填写上重要记录的前因后果,需求背景,是一个好的习惯。

尾部Footer

添加一些额外的hook,比如提交记录之后,自动关闭jira的工单(JIRA和gitlab等是可以联动的)。在比如触发一些文档编译或者其他动作。

这部分自定义行也是比较强的。

Skip CI

最后还有一个skip  CI选项。一般的ci工具,都可以设置提交代码时自动触发编译。但你可以告诉它忽略本次提交。这可能是因为你提前预判到了一些构建风险,或者就是不想编译。

End

最后,看一个典型的提交记录,有了工具的支持,我们的瞎扯也看得正经起来。

fix(order): 修复了1分钱买汽车的bug  商务反馈可以1分钱买汽车,目前已经卖出了100w量  Closes #2455  [skip ci]

其实,提交的核心是type和subject。一个用来表示它的提交类型,一个用来对提交进行概括性总结,写好了这两点,就能轻轻松松秒杀80%的程序员了。

有了这些基础,从commit log,自动生成change  log,就变的非常的容易。配合持续集成平台,自动生成发版的变更记录,也是可行的,这也是为什么团队管理,都在一直强调git的提交规范。因为它确实非常有用。

到此,相信大家对“如何写Commit记录”有了更深的了解,不妨来实际操作一番吧!这里是编程网网站,更多相关内容可以进入相关频道进行查询,关注我们,继续学习!

--结束END--

本文标题: 如何写Commit记录

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

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

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

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

下载Word文档
猜你喜欢
  • 如何写Commit记录
    本篇内容主要讲解“如何写Commit记录”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“如何写Commit记录”吧!安装插件在IDEA的Marketplace中,...
    99+
    2024-04-02
  • 如何写commit log记录及提交
    这篇文章主要介绍了如何写commit log记录及提交的相关知识,内容详细易懂,操作简单快捷,具有一定借鉴价值,相信大家阅读完这篇如何写commit log记录及提交文章都会有所收获,下面我们一起来看看吧。安装插件在ID...
    99+
    2023-07-02
  • 怎样写commit log记录及如何提交有哪些约定
    目录前言安装插件提交类型Type范围scope其他主题subject正文Body尾部FooterSkip CIEnd前言 据说,80%的程序员,不会写commit记录。这个比例在无规...
    99+
    2024-04-02
  • git如何查看自己的commit记录
    要查看自己的commit记录,可以使用`git log`命令。下面是一些常用的`git log`命令选项:- `git log`: ...
    99+
    2023-08-23
    git
  • git如何清除commit
    本篇内容主要讲解“git如何清除commit”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“git如何清除commit”吧!git取消commit的方法:1、利用“git rm”命令撤销;2、利用...
    99+
    2023-06-21
  • github如何删除commit
    随着程序员们对Github的使用越来越熟练,可能会遇到各种各样的问题。其中,删除一个commit就是常见的问题之一。在撰写本文之前,我们需要了解一些Git基础知识,以便更好地理解删除commit的过程。Git是一个分布式版本控制系统(DVC...
    99+
    2023-10-22
  • 如何使用Go编写Shell脚本并记录日志?
    Shell脚本是Linux系统中常用的命令脚本语言,通过编写Shell脚本可以方便地执行一系列命令。而Go语言作为一门高效、静态类型的编程语言,也可以用来编写Shell脚本,并且可以方便地记录日志。本文将为大家介绍如何使用Go编写Shel...
    99+
    2023-06-20
    shell 日志 leetcode
  • JavaScript如何重写原生alert并记录弹框次数
    这篇文章主要介绍JavaScript如何重写原生alert并记录弹框次数,文中介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们一定要看完!重写原生alert,记录弹框次数(function() ...
    99+
    2024-04-02
  • 你知道如何编写PHP API日志记录算法吗?
    PHP API日志记录算法是一种记录API请求和响应的方法,这对于开发人员和系统管理员来说非常有用。在本文中,我们将介绍如何编写PHP API日志记录算法,并提供一些示例代码来帮助您入门。 确定日志记录的目的 首先,您需要确定您希望记录...
    99+
    2023-10-08
    api 日志 编程算法
  • git commit后如何撤销
    git commit后撤销的方法:1、使用git reset命令;2、使用git revert命令;3、使用git cherry-pick命令。git是一个分布式版本控制系统,它允许用户将代码仓库中的更改进行提交(commit)。但是有时候...
    99+
    2023-07-27
  • 如何撤销git的commit
    Git是一种流行的版本控制工具,但是即使是经验丰富的开发人员也有可能意外地提交了错误的代码或个人信息。在这种情况下,撤销提交是至关重要的,以便在不破坏代码库历史记录的情况下修复问题。以下是如何撤销git提交的步骤。一、撤销最近的提交如果您已...
    99+
    2023-10-22
  • mysql如何新增记录
    这篇文章将为大家详细讲解有关mysql如何新增记录,小编觉得挺实用的,因此分享给大家做个参考,希望大家阅读完这篇文章后可以有所收获。mysql新增记录的方法:1、使用“INSERT INTO 表名 列名[,...
    99+
    2024-04-02
  • PHP中如何编写高效的日志文件记录算法?
    PHP是一种在Web开发中广泛使用的编程语言。在Web开发中,日志文件记录是非常重要的,因为它可以帮助我们跟踪和排除问题。因此,编写高效的日志文件记录算法对于保证应用程序的稳定性和可靠性至关重要。 在本文中,我们将介绍如何在PHP中编写高效...
    99+
    2023-06-18
    日志 编程算法 文件
  • git如何修改commit时间
    这篇文章主要介绍“git如何修改commit时间”,在日常操作中,相信很多人在git如何修改commit时间问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”git如何修改commit时间”的疑惑有所帮助!接下来...
    99+
    2023-07-02
  • git中如何取消 commit 操作
    在使用 Git 进行版本控制时,commit 操作是必不可少的一步,它表示将当前代码更改保存到本地仓库中。然而,在实际使用过程中,我们有时会遇到一些问题,需要取消 commit 操作。本文将会介绍如何取消 commit 操作。取消 add ...
    99+
    2023-10-22
  • git如何查看commit修改
    这篇文章主要讲解了“git如何查看commit修改”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“git如何查看commit修改”吧!git查看commit修改的方法:1、利用“git log...
    99+
    2023-07-02
  • sql中如何更新记录
    小编给大家分享一下sql中如何更新记录,希望大家阅读完这篇文章之后都有所收获,下面让我们一起去探讨吧!sql更新记录的命令是UPDATE。UPDATE命令用于修改或更新mysql中的数据,该命令可以同时更新...
    99+
    2024-04-02
  • 如何使用Java和Numpy编写更好的算法日志记录?
    在编写算法时,日志记录是非常重要的。它可以帮助我们了解算法的运行情况,发现问题和解决问题。在本文中,我们将介绍如何使用Java和Numpy编写更好的算法日志记录。 一、Java中的日志记录 Java中的日志记录是通过java.util.l...
    99+
    2023-07-26
    numpy 日志 编程算法
  • Go 开发技术教程:如何编写高效的日志记录?
    Go 是一种快速、高效的编程语言,广泛应用于Web应用程序和云计算应用程序的开发中。在开发过程中,日志记录是一项非常重要的工作。本文将为大家介绍如何编写高效的日志记录,以及如何在 Go 中实现它。 什么是日志记录? 日志记录是一种记录应用程...
    99+
    2023-06-19
    开发技术 教程 日志
  • CMD如何实现记录器
    这篇文章主要介绍了CMD如何实现记录器,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。安装 把代码保存为cmd.bat 放置system32下 把...
    99+
    2023-06-09
软考高级职称资格查询
推荐阅读
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作