我的编程空间,编程开发者的网络收藏夹
学习永远不晚

如何写Commit记录

短信预约 -IT技能 免费直播动态提醒
省份

北京

  • 北京
  • 上海
  • 天津
  • 重庆
  • 河北
  • 山东
  • 辽宁
  • 黑龙江
  • 吉林
  • 甘肃
  • 青海
  • 河南
  • 江苏
  • 湖北
  • 湖南
  • 江西
  • 浙江
  • 广东
  • 云南
  • 福建
  • 海南
  • 山西
  • 四川
  • 陕西
  • 贵州
  • 安徽
  • 广西
  • 内蒙
  • 西藏
  • 新疆
  • 宁夏
  • 兵团
手机号立即预约

请填写图片验证码后获取短信验证码

看不清楚,换张图片

免费获取短信验证码

如何写Commit记录

本篇内容主要讲解“如何写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 其他改动。比如一些注释修改或者文件清理。不影响class="lazy" data-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记录”有了更深的了解,不妨来实际操作一番吧!这里是编程网网站,更多相关内容可以进入相关频道进行查询,关注我们,继续学习!

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

如何写Commit记录

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

下载Word文档

猜你喜欢

如何写commit log记录及提交

这篇文章主要介绍了如何写commit log记录及提交的相关知识,内容详细易懂,操作简单快捷,具有一定借鉴价值,相信大家阅读完这篇如何写commit log记录及提交文章都会有所收获,下面我们一起来看看吧。安装插件在IDEA的Marketp
2023-07-02

git如何查看自己的commit记录

要查看自己的commit记录,可以使用`git log`命令。下面是一些常用的`git log`命令选项:- `git log`: 显示所有的commit记录,最近的commit记录排在最上面。- `git log --oneline`:
2023-08-23

git如何清除commit

本篇内容主要讲解“git如何清除commit”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“git如何清除commit”吧!git取消commit的方法:1、利用“git rm”命令撤销;2、利用
2023-06-21

github如何删除commit

随着程序员们对Github的使用越来越熟练,可能会遇到各种各样的问题。其中,删除一个commit就是常见的问题之一。在撰写本文之前,我们需要了解一些Git基础知识,以便更好地理解删除commit的过程。Git是一个分布式版本控制系统(DVC
2023-10-22

如何撤销git的commit

Git是一种流行的版本控制工具,但是即使是经验丰富的开发人员也有可能意外地提交了错误的代码或个人信息。在这种情况下,撤销提交是至关重要的,以便在不破坏代码库历史记录的情况下修复问题。以下是如何撤销git提交的步骤。一、撤销最近的提交如果您已
2023-10-22

git commit后如何撤销

git commit后撤销的方法:1、使用git reset命令;2、使用git revert命令;3、使用git cherry-pick命令。git是一个分布式版本控制系统,它允许用户将代码仓库中的更改进行提交(commit)。但是有时候
2023-07-27

如何记录 JdbcTemplate.batchUpdate 中更新不匹配的记录?

如何在 jdbctemplate.batchupdate 中记录更新不匹配的记录jdbctemplate 提供了 batchupdate 方法,允许批量执行更新语句。然而,当特定 where 子句条件不匹配时,该方法无法提供有关未更新记录
如何记录 JdbcTemplate.batchUpdate 中更新不匹配的记录?
2024-10-24

git如何查看commit修改

这篇文章主要讲解了“git如何查看commit修改”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“git如何查看commit修改”吧!git查看commit修改的方法:1、利用“git log
2023-07-02

git如何修改commit时间

这篇文章主要介绍“git如何修改commit时间”,在日常操作中,相信很多人在git如何修改commit时间问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”git如何修改commit时间”的疑惑有所帮助!接下来
2023-07-02

JdbcTemplate.batchUpdate 如何记录不匹配 Where 子句的记录?

记录 jdbctemplate.batchupdate 中不匹配 where 子句的记录在使用 jdbctemplate.batchupdate 批量执行 sql 语句时,当某些记录与 where 子句不匹配时,需要一种方法来记录这些未更
JdbcTemplate.batchUpdate 如何记录不匹配 Where 子句的记录?
2024-10-24

CMD如何实现记录器

这篇文章主要介绍了CMD如何实现记录器,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。安装 把代码保存为cmd.bat 放置system32下 把cmd.exe copy为cm
2023-06-09

编程热搜

  • Python 学习之路 - Python
    一、安装Python34Windows在Python官网(https://www.python.org/downloads/)下载安装包并安装。Python的默认安装路径是:C:\Python34配置环境变量:【右键计算机】--》【属性】-
    Python 学习之路 - Python
  • chatgpt的中文全称是什么
    chatgpt的中文全称是生成型预训练变换模型。ChatGPT是什么ChatGPT是美国人工智能研究实验室OpenAI开发的一种全新聊天机器人模型,它能够通过学习和理解人类的语言来进行对话,还能根据聊天的上下文进行互动,并协助人类完成一系列
    chatgpt的中文全称是什么
  • C/C++中extern函数使用详解
  • C/C++可变参数的使用
    可变参数的使用方法远远不止以下几种,不过在C,C++中使用可变参数时要小心,在使用printf()等函数时传入的参数个数一定不能比前面的格式化字符串中的’%’符号个数少,否则会产生访问越界,运气不好的话还会导致程序崩溃
    C/C++可变参数的使用
  • css样式文件该放在哪里
  • php中数组下标必须是连续的吗
  • Python 3 教程
    Python 3 教程 Python 的 3.0 版本,常被称为 Python 3000,或简称 Py3k。相对于 Python 的早期版本,这是一个较大的升级。为了不带入过多的累赘,Python 3.0 在设计的时候没有考虑向下兼容。 Python
    Python 3 教程
  • Python pip包管理
    一、前言    在Python中, 安装第三方模块是通过 setuptools 这个工具完成的。 Python有两个封装了 setuptools的包管理工具: easy_install  和  pip , 目前官方推荐使用 pip。    
    Python pip包管理
  • ubuntu如何重新编译内核
  • 改善Java代码之慎用java动态编译

目录