git提交注释规范插件

七夜琉璃

已于 2024-06-08 16:16:41 修改

阅读量3.9k

点赞数 32

分类专栏： Java开发工具文章标签： git java

于 2024-04-24 16:08:04 首次发布

本文链接：https://blog.csdn.net/qiyeliuli/article/details/108253381

版权

本文介绍了在团队开发中采用统一的代码提交规范的重要性，以及如何在sourceTree和IDEA中配置GitCommitMessage模板，确保提交信息清晰、结构化，便于代码合并和问题跟踪。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1、前言

为什么要注重代码提交规范？

在团队协作开发时，每个人提交代码时都会写 commit message。
每个人都有自己的书写风格，翻看我们组的git log, 可以说是五花八门，十分不利于阅读和维护。
一般项目开发都是多分支共存，master、develop、feature、hotfix、release等分支，在这么多分支中，我们会有一个稳定的master分支，但是我们需要将分支代码进行merge。存在规范的commit message可以帮助我们很轻松的合并代码以及发现问题。例如使用Jenkins自动化部署时，我们可以根据jenkins拉取commit message中的Closes issues验证BUG等。
因此，我们需要制定统一标准，促使团队形成一致的代码提交风格，更好的提高工作效率，成为一名有追求的工程师。

2、sourceTree提交注释模版配置

sourceTree - 偏好设置-提交
在这里插入图片描述
点击提交自动就出现

【提交类型】:feature、fix、docs、style、refactor、perf、test、build:、ci、chore、revert
【提交影响

最低0.47元/天解锁文章

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

七夜琉璃

关注关注

32
点赞
踩
17

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

专栏目录

【前端】代码Git提交规范之约定式提交和Commitizen简化提交流程

Yong.Sunshine

09-01

921

在我们目前的前端项目中，我们采用git作为版本控制工具。使用git管理项目意味着我们经常需要提交代码。当我们执行命令时，我们被要求提供一个描述信息。然而，由于每个人的理解和表达方式不同，提交信息的多样性有时会导致信息的模糊和不明确。这不仅影响了代码的可追溯性，还可能隐藏潜在的风险。因此，为了提高团队的协作效率和代码质量，我们需要建立一套统一的提交规范，确保每次提交的信息都是清晰、一致且具有描述性的。那么该怎么规范呢？

git提交也有规范，看下大神是怎么做的

weixin_43846916的博客

09-19

646

求关注求转发一、目的无规矩不成方圆，当查看git提交历史的时候，发现每个人git的提交记录都有自己的风格和习惯，并没有一套完整的规范，不利于阅读和维护。所以需要一套git提交规范，使得提交记录清晰明了，让人一看就能知道此次提交的目的。二、业界比较认可和常用的规范AngularJS是目前使用最广的一种规范，比较合理和系统，也有相应的工具和插件支持。规范结构：三部分组成：header（关键）、body（可省略）、footer（可省略）建议这三个部分，每个部分的字符都不要超过100字符，避免自动换行影响美观//&

参与评论您还未登录，请先登录后发表或查看评论

git-commit-lint-vscode:vscode一款git 规范化提交插件

05-17

git-commit-lint-vscode 在日常的开发中,目前主流的代码管理工具就是 git 了,当我们对代码进行改动了,首先得git commit提交到本地仓库,git 规定了提交时必须填写提交信息作为改动说明,保存 commit 历史中,可以找到历史代码,也方便他人 review,还可以输出 CHANGELOG,对项目的研发质量都有很大的提升。但是在平时的工作中,大部分对于commit 都是简单的填写,没有好好的重视,这对于项目管理和维护来说,无疑是不友好的。这个插件就是规范化git提交规范,让你的提交不仅"好看"还"实用" git 规范提交从何说起? git 规范提交从哪里开始的呢?起源在哪呢?emmmmmm,这就追溯到了Angular了! 让我们看下Angular社区的提交规范这个提交记录是不是一目了然?所以git commit规范下还是很有必要的! 说明类型 emji

【规范】看看人家Git提交描述，那叫一个规矩

JavaDog程序狗

03-08

2005

1.IDEA Git描述规范插件:git commit message helper 2.Git提交描述格式规范,type、scope、subject、body、footer内容分析 3.实例Git提交描述解析:新功能提交、bug修复、文档提交

应用实战｜IDEA中的Git插件工具

热门推荐

阿甘兄

08-22

2万+

概述使用git commit template可以规范我们在IDEA提交代码是的注释规范，使用效果如下：首先提交时，点击如下图标：填写提交内容影响类型、影响范围、短注释、长注释等：填写完后，自动生成模板：安装步骤打开settings下的plugin里搜索git commit template插件：安装完后重启IDEA就可以愉快的使用了。 ...

代码提交commit规范工具

qq_38377190的博客

02-18

1519

下载插件，以下是插件名安装后重启idea。

前端代码git提交规范插件Commitizen详解

半夏_2021的博客

04-24

2772

前端代git提交规范和VScode 可视化插件

commit-template-idea-plugin：用于IntelliJ的Git提交模板插件

02-03

用于IntelliJ的Git提交模板插件该插件允许使用以下模板创建提交消息： <type>(<scope>): <subject> <BLANK> <body> <BLANK> <footer> 从角项目的贡献准则。安装直接从IDE插件管理器安装（文件>设置>插件>浏览器存储库> Git提交模板）用法伙伴执照根据Apache许可版本2.0（“许可”）许可；除非遵守许可，否则不得使用此文件。您可以在以下位置获得许可的副本：除非适用法律要求或以书面形式同意，否则根据“许可”分发的软件将按“原样”分发，而没有任何明示或暗示的保证或条件。有关许可下特定的

结合企业实践来规范你的Git commit（含插件使用指南）

Jay的个人博客

04-12

2976

结合企业实践来规范你的Git commit，含 IDEA的Git commit template的插件、VS Code 的git-commit-plugin插件的使用指南

Git提交模板插件(IntelliJ IDEA)安装配置完全指南

gitblog_07443的博客

09-13

1021

Git提交模板插件(IntelliJ IDEA)安装配置完全指南 commit-template-idea-plugin Git commit template Plugin for IntelliJ 项目地址: https://...

idea --Git Commit Template插件

qq_38619449的博客

08-29

2428

Git Commit Template是一款免费的IntelliJ IDEA插件，用于提供Git提交模板。ci 持续集成方面的更改。feat 功能feature的意思，也是最常用的。当你的功能有变更的时候，都可以采用这种类型的type。指的是代码结构的调整，比如使用了一些设计模式重新组织了代码。build 影响编译的一些更改，比如更改了maven插件、增加了npm的过程等。style 代码格式调整，比如执行了format、更改了tab显示等。test 这个简单，就是增加了单元测试和自动化相关的代码。

【代码规范】git提交规范--附idea插件分享

代码瞬间移动工程师的博客

05-22

3045

目录前言git提交规范提交格式type参数介绍示例idea提交规范插件前言 git作为当前最为火热的开源分布式版本控制系统，能够在团队协作中极大的提升合作效率。而高效的协作离不开规范化的管理，在提交代码时规范化能够在后续出现问题的时候能快速回溯起因，也能更清晰的观察到整个项目的开发情况。 git提交规范提交格式 type(scope):message type参数介绍 type：指的代码提交类型，不同的提交类型表示对应不同的代码改动 feat：提交新的功能 fix：bug的修复 docs：文档格.

提升效率：利用工具自动生成 Git 提交注释

十年运维开发经验的王义杰在此分享自己的知识和经验

03-30

581

自动化生成 Git 提交注释可以显著提高开发效率，减少为编写描述性强且规范的提交注释所花费的时间。通过使用现有工具、定制化脚本或IDE插件，开发者可以根据项目需求和个人喜好选择最适合的方法。实现自动化的关键在于理解项目的代码结构和变更模式，从而设计出既智能又实用的自动化方案。