Git 提交规范

已于 2024-09-22 22:22:03 修改
阅读量662 收藏 4
点赞数 6
分类专栏： 开发工具 Git 文章标签： git
于 2024-09-22 22:17:44 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_42703501/article/details/142444872
版权

一、Git 提交规范的基本格式

通常，Git 提交信息采用以下格式：

<type>: <subject>

<body>

<footer>
  1. type（提交类型）：用于说明提交的性质，常见的类型有以下几种：
    • feat：新功能（feature）。
    • fix：修复 bug。
    • docs：文档修改。
    • style：代码格式调整（不影响代码逻辑）。
    • refactor：代码重构（不添加新功能也不修复 bug）。
    • perf： 性能优化
    • revert： 回退
    • test：增加测试用例。
    • chore：其他杂项事务，如更新构建工具等。
  2. subject（简短描述）：用简洁的语言描述本次提交的主要内容。
  3. body（详细描述）：如果需要，可以在 body 部分提供更详细的提交信息，包括背景、解决方法等。
  4. footer（可选）：可以用于添加一些关联的问题编号、合并请求编号等信息。

例如：

feat: 添加用户登录功能

实现了用户登录的页面和后端逻辑，支持用户名和密码登录。

Closes #123

在这里插入图片描述

二、Git 提交辅助插件

Git Commit Message Helper一 个可帮助您标准化提交内容的插件,该插件是源自git-commit-template的加强版,添加一系列个性化的配置。

（一）安装

在 IntelliJ IDEA 中 Settings -> Plugins 搜索 Git Commit Message Helper 安装并重启IDEA
在这里插入图片描述

（二）使用

提交时
在这里插入图片描述

填写提交信息
在这里插入图片描述

ZuuuuYao
关注
专栏目录
Git Commit提交规范总结
拾年一剑 的专栏
02-27 6354
团队协作中，规范的Git提交记录，使提交历史明确可追溯，有助于更好的协作，方便后期代码的开发和维护
全栈笔记_规范篇（husky管理Git代码提交格式）
wwv的博客
01-26 797
git 代码提交格式规范管理
Java项目Git提交规范
訾博（ZiBo）的博客
06-25 618
在Java项目中，遵循良好的Git提交规范有助于提高代码的可维护性、可读性和团队协作效率。
代码检测规范和git提交规范
weixin_61933613的博客
02-18 2581
之前开发的项目，代码检测和提交规范都是已经配置好的，最近自己新建的项目就记录下相关配置过程。
Git---git本地配置commit_template提交模板，规范开发
最新发布
COCOLI_BK的博客
07-15 1482
Commit Template 是一个预定义的文本文件，其中包含了提交信息的基本结构和指南。当开发者在进行代码提交时，Git 会根据这个模板自动生成或提示提交信息的格式，从而确保每次提交的信息都是一致且符合规范的。
git 知：提交格式
canpool
07-27 991
git是一个分布式版本控制系统，它可以用来记录一个或若干个文件内容的变化，以便将来查阅特定版本的修订情况。为了便于追溯，那么每次的变化就需要做好记录，不然到时候再看，可能就不明其意了。本文所讲的提交格式，实际上就是对每次记录所做的规范说明，按照所说的格式书写，将便于以后维护。.........
Git提交信息格式
朱工的专栏
11-23 5286
什么情况需要提交 每当完成了一个新功能、修复了一个错误、重构一个模块或者调整格式时，都应该提交一次代码，以便版本工具记录这次修改。 规定：不能将不相关的修改一块提交，混合不同的功能会使得以后的问题查找或者其他成员浏览历史变得困难。 提交信息格式 <type>: <subject> //空一行 <body> type：用于说明本次提交的类别，规定为以下几种： feat：新功能 fix：修复错误 refactor：重构代码 style：调整代码格式（不影响代码运行
【Git】提交规范：格式，类型，范围
记录
03-15 1764
学习一下git提交规范 类型，范围。
Git提交规范
Creabine的博客
12-13 2443
最近公司的前端团队分了组，我根据兴趣加入了基础设施建设组，负责做一些方便和规范开发的东西。第一个产出是增加了Git的提交规范，之前参与开源项目时接触到的，感觉很有意思，也很实际，用得到。 参考资料: 阮一峰-Commit message 和 Change log 编写指南 Git提交规范 意义及现状 在开发过程中，Git每次提交代码，都需要写Commit message（提交说明），规...
Git提交规范结合实践
04-11
Git提交规范是软件开发团队协作中的重要组成部分，它有助于保持代码历史清晰，便于代码审查，回溯更改，以及自动化发布流程。以下是对标题和描述中所述知识点的详细说明： 1. **提交过程规范**： - **初始提交**：...
git提交信息模板
02-04
git提交信息模板 git提交信息模板 git提交信息模板 git提交信息模板
git-commit-lint-vscode:vscode一款git 规范化提交插件
05-17
这个插件就是规范化git提交规范,让你的提交不仅"好看"还"实用" git 规范提交从何说起? git 规范提交从哪里开始的呢?起源在哪呢?emmmmmm,这就追溯到了Angular了! 让我们看下Angular社区的提交规范 这个提交记录是不是...
git提交规范，规范自己的提交标准
m0_67393413的博客
08-01 1087
先自我介绍一下，小编13年上师交大毕业，曾经在小公司待过，去过华为OPPO等大厂，18年进入阿里，直到现在。为了规范我的git提交内容，提交的时候commit-m“备注的信息”，但是每个人的备注信息千奇百怪，为了统一，我们进行了git的规范。尝试帮你自动修复，如果修复成功则会帮你把修复好的代码提交，如果失败，则会提示你错误，让你修好这个错误之后才能允许你提交代码。在我们修改代码之后，使用gitcz代替gitcommit-m，然后就能描述自己的git提交的内容了。如上配置，每次它只会在你本地。...
配置项目的代码规范（代码格式规范 + git 提交规范）
ailsa_csdn的博客
04-07 2704
配置项目中的代码规范，达到一个统一标准：包含代码编码的格式规范、git提交时的规范
配置GIT代码提交格式
唯爱丶卡卡西的博客
03-10 1039
引：代码提交是开发再熟悉不过的事情了，几乎天天都要如此，但是针对于代码提交的格式，我想每个公司都有自己的一套提交规范把，毕竟杂乱不堪的提交log 让leader看着都烦。 1. 配置commit_msg模板： 输入： [ vi ~/.gitconfig ] 命令 如下图片： 而commit_template.txt 就是自定义的提交格式。 对了，特别注意点，需要修改成UNIX系统的，如下：...
GIT提交规范-范式和示例
weixin_45673401的博客
12-13 439
GIT提交规范-范式和示例
怎么限制git提交规范
07-12
要限制Git提交规范，可以采取以下几个方法： 1. 使用Git钩子（Git hooks）：Git钩子是在特定Git事件发生时自动触发的脚本。你可以在本地或者远程仓库中设置Git钩子来验证提交信息的规范性。比如，在`pre-commit`钩子中可以编写脚本，检查提交的消息是否符合规范，如果不符合规范则阻止提交。 2. 使用Git提交模板（Git commit template）：你可以创建一个提交模板文件，定义提交信息的格式和规范，并将其配置为Git的默认提交模板。这样，在每次提交时，Git会自动打开该模板文件供你填写提交信息。你可以在模板文件中添加规范说明，以引导开发者按照规范填写信息。 3. 使用代码审查工具：一些代码审查工具（例如，Gerrit、Phabricator等）提供了对提交信息进行验证的功能。你可以配置这些工具来检查提交信息是否符合规范，并在不符合规范时拒绝合并。 4. 培训团队成员：进行团队内部的培训，提醒团队成员遵守提交规范，并说明为什么提交规范对于项目的质量和协作至关重要。 无论采取哪种方式，都应该明确规范的要求，并与团队成员进行充分的沟通和培训，以确保规范的有效实施。
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

ZuuuuYao

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值