Git 提交描述规范

已于 2024-07-29 17:25:21 修改
阅读量515 收藏 8
点赞数 9
分类专栏： git 文章标签： git intellij idea idea
于 2024-07-29 16:35:08 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/GuoyangGuo/article/details/140774445
版权

为什么要有提交规范

在项目开发中，只要涉及到源码管理一般都会采用 Git 这类版本控制工具来管理，但是如果项目中的参与人员较多，每个开发人员向 Git 仓库中提交的 commit message 没有统一的格式的话，那么对于整个 git log 来说那真是什么“妖魔鬼怪”都有了， 好的提交规范不仅赏心悦目更方便项目管理，追踪复查问题，减少管理成本。

提交案例

错误的提交案例

从下面的截图的提交日志中，压根无法得知每次提交的目的是什么，甚至看的云里雾里。
image.png

良好的提交案例

从下面的截图的提交日志中，可以很清晰的得出此次提交的目的是新增功能还是修复 bug，涉及的模块和具体的改动。
image.png

规范的Git提交描述格式

一个好的提交信息都应该包含提交类型、一个简洁的主题和一个详细的描述，推荐的提交信息格式如下：

<type>(<scope>): <subject>

<BLANK LINE>

<body>

<BLANK LINE>

<footer>

type 代表提交类型，scope 代表受本次提交影响的范围，subject 代表本次提交简单的主题，LANK LINE 表示空行， body是提交的详细描述，footer 是与本次提交关联的元数据信息，如：需求单的链接或者 bug 清单的链接。
常见的提交类型（type）：

  • feat：新功能
  • fix：bug 修复
  • docs：文档修改
  • style：格式修改
  • refactor：代码重构
  • test：测试
  • perf：性能提升
  • build：系统构建
  • ci：ci 配置
  • revert：回滚版本
  • chore： 其他修改，比如辅助工具等

IDEA 配置提交格式

IDEA 中提供了 Git Commit Message Helper插件来配置 Git 提交信息模板。

安装插件

IDEA Plugins 中搜索 Git Commit Message Helper点击 **Install，**安装完成后可在 Other Settings找到 Git Commit Message Helper进行配置。
image.png
image.png

插件使用

在提交代码，编写 message 时点击上方的小图标，可通过插件填写 message 信息，点击 ok 会生成好 message 到输入框中，再点击提交即可。
image.png

geekyous
关注
  • 9
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
git提交规范
just
12-14 270
关于Commit message 每次提交，Commit message 都包括三个部分： header body footer 格式： <type>(<scope>): <subject> <BLANK LINE> // 空行 <body> <BLANK LINE> // 空行 <footer> 1.其中，header 是必需的，body 和 footer 可以省略。 2.不管是哪一个部分，任何一行都不得超过72个
Git代码提交描述规范
栗少的博客
03-23 1826
我相信大家肯定还是会疑惑。这里就以我之前理解的 commit 规范为列子。希望起到一个抛砖引玉的作用。毕竟 commit 信息只是人为规范。不同公司，不同项目，不同人有着自己的见解。因为作者本身是一名爱岗敬业的 Android 程序员，可能提交日志相对于倾向于移动端，所以如果大家有更好的提交日志分享。这里非常欢迎在评论中看到你的回答~ 反面例子 在了解我的提交规范之前，我们来看一些反面的 commit 信息： 修改登录界面的Bug 修改空指针异常 增加提示 代码优化 调整UI 从上述 comm
Git提交规范及使用说明（简略笔记）
m0_64276053的博客
05-25 3338
一.Git提交规范 一次提交包含四个信息： commit message - 提交的内容相关描述 author & committer - 作者及提交者 changed files - 修改的文件 hash & parent - 提交内容的hash及在提交树上的位置 1.提交信息 一般包括<header><body><footer>三部分。 <header>是必须的，一般在50个字符之内，其结构为：（其中<scope>
【规范】看看人家Git提交描述，那叫一个规矩
JavaDog程序狗
03-08 1685
1.IDEA Git描述规范插件:git commit message helper 2.Git提交描述格式规范,type、scope、subject、body、footer内容分析 3.实例Git提交描述解析:新功能提交、bug修复、文档提交
git 提交规范Type
zzkeung的博客
03-29 737
feat：新功能（feature） fix：修补bug docs：文档（documentation） style： 格式（不影响代码运行的变动） refactor：重构（即不是新增功能，也不是修改bug的代码变动） test：增加测试 chore：构建过程或辅助工具的变动 tag: 针对与每次版本的提交 revert: 撤销，版本回退 perf: 性能优化 ...
git commit 提交规范
最新发布
schezhiyong的博客
05-25 325
在软件开发中，良好的Git提交记录规范有助于保持代码库的清晰和易维护。常见的提交记录规范之一是由Angular团队提出的，它提供了一种结构化的提交消息格式，便于自动化工具处理和生成变更日志。
Git Commit提交规范总结
拾年一剑 的专栏
02-27 6203
团队协作中，规范的Git提交记录，使提交历史明确可追溯，有助于更好的协作，方便后期代码的开发和维护
git提交规范，规范自己的提交标准
m0_67393413的博客
08-01 1048
先自我介绍一下，小编13年上师交大毕业，曾经在小公司待过，去过华为OPPO等大厂，18年进入阿里，直到现在。为了规范我的git提交内容，提交的时候commit-m“备注的信息”，但是每个人的备注信息千奇百怪，为了统一，我们进行了git的规范。尝试帮你自动修复，如果修复成功则会帮你把修复好的代码提交，如果失败，则会提示你错误，让你修好这个错误之后才能允许你提交代码。在我们修改代码之后，使用gitcz代替gitcommit-m，然后就能描述自己的git提交的内容了。如上配置，每次它只会在你本地。...
git 提交信息规范文档
10-28
本文档所阐述的Git提交信息规范，是为了让开发者在提交代码时能够提供更清晰、一致的信息，从而提高工作效率和代码质量。 首先，规范的提交信息可以提供更多的历史信息，使项目历史更加清晰。一个好的提交信息可以...
Git提交规范
Creabine的博客
12-13 2391
最近公司的前端团队分了组，我根据兴趣加入了基础设施建设组，负责做一些方便和规范开发的东西。第一个产出是增加了Git的提交规范，之前参与开源项目时接触到的，感觉很有意思，也很实际，用得到。 参考资料: 阮一峰-Commit message 和 Change log 编写指南 Git提交规范 意义及现状 在开发过程中，Git每次提交代码，都需要写Commit message（提交说明），规...
Git 学习笔记——git 提交规范和 Github/Gitee 使用说明
un357951的博客
01-24 867
我们以vscode项目进行介绍访问https://github.com/microsoft/vscode 即可看到如下的界面页面的左上角：Star所以尽量不要像朋友圈集赞一样要求身边朋友刷starFork：Fork操作实际上是创建一个仓库的副本，并将仓库的upstream指向原仓库小问题：为什么要fork呢？为什么不直接push呢？fork方便了多人协作Watch：Watch操作可以向你的邮箱中推送该仓库的推送信息提示：如果不是特别重要的项目，不要随意点Watch，否则很容易邮箱被轰炸。
IDEA中Git提交步骤（提交到中央仓库详细步骤）及使用操作注意事项
q_1092535160的博客
07-02 6354
Git+码云+IDEA使用步骤： 一、一定要先pull(先下载下来仓库的项目)等运行完毕 二、pull好之后，再add 三、add之后再点击add上边的Commit File 四、之后add上边的Commit File会变成Commit Directory点击 五、点击绿色的对勾，commit拍快照时点击commit and push 六、最后再push！ 相关文档参考：Git提交步骤 ...
git提交代码，type说明
ITgagaga的博客
07-17 469
git commit type
IDEA：Git 提交规范插件
欢迎来到 ABin-阿斌的博客：写一生代码，创一世佳话，筑一览芳华。
01-08 4672
文章目录一、概述二、安装步骤三、参数详解 一、概述 使用git commit template可以规范我们在IDEA提交代码是的注释规范 使用效果如下：首先提交时，点击如下图标： 填写提交内容影响类型、影响范围、短注释、长注释等： 填写完后，自动生成模板： 二、安装步骤 打开settings下的plugin里搜索git commit template插件： 安装完后重启IDEA就可以愉快的使用了。 三、参数详解 例子： fix(DAO):用户查询缺少username属
【Git】提交规范：格式，类型，范围
记录
03-15 1720
学习一下git提交规范 类型，范围。
git commit 提交规范及配置
liyp921210的博客
02-28 804
git commit 提交规范及配置
Git提交规范详解
高性价比服务器就选：蓝易云
07-09 1694
遵循Git提交规范有助于提高代码管理的可读性和可维护性。通过清晰的提交消息，团队成员可以快速了解每次提交的目的和内容，方便代码审查、版本控制和问题追踪。同时，使用规范的提交消息也有助于自动生成变更日志和版本发布说明等文档。请注意，具体的Git提交规范可以根据团队的实际需求进行定制和调整。以上提供的是一种常见的规范作为参考，您可以根据团队的喜好和项目特点进行适当的修改。Git提交规范是一种良好的实践，有助于团队协作和代码管理。
git提交commit规范
09-29
Git提交commit规范可以帮助我们在提交代码时更加规范、清晰地记录每次提交的目的和内容。常见的git提交commit规范有以下几种： 1. 使用约定的提交消息格式：一般使用"[类型]: 提交说明"的格式，其中类型可以是feat（新功能）、fix（修复bug）、docs（文档修改）、style（代码格式修改）、refactor（代码重构）、test（测试代码修改）等。 例如：feat: 添加用户注册功能 2. 提交消息的内容要简明扼要，清晰明了，用一句话描述本次提交的目的和内容。 3. 可以在提交消息中添加关联的issue编号，方便跟踪和查看。 4. 提交消息的第一行要尽量控制在50个字符以内，更详细的说明可以在第一行后面进行补充。 5. 可以使用一些常用的提交类型和动词，如feat（添加）、fix（修复）、docs（文档）、style（代码样式）、refactor（重构）、test（测试）、chore（构建/工具/其他）等。 请注意，git提交commit规范可以根据团队的实际情况和需求进行调整和扩展，重要的是保持一致性和清晰性。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值