Git提交描述

最新推荐文章于 2024-04-24 16:08:04 发布
最新推荐文章于 2024-04-24 16:08:04 发布
阅读量519 收藏 9
点赞数 4
分类专栏： java 文章标签： git
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_45817985/article/details/136874256
版权
本文讨论了在团队开发中采用统一的Gitcommitmessage规范的重要性，推荐使用GitCommitMessageHelper插件，以及对Git提交描述的Header、Body和Footer结构进行详细解析，以提高代码管理和维护效率。
摘要由CSDN通过智能技术生成

🔔 分析
在团队开发中，一般都会使用Git 版本控制工具来管理代码，每个组员提交代码时都会写 commit message。如果没有一个统一标准规范，每个人都有自己的风格，项目小成员少还好，如果团队成员多，项目复杂，十分不利于阅读管理和维护。

通过上方图中提交记录对比，明显感觉上方Git提交记录较为规范美观。虽然本狗写的提交记录也比较清晰，但是随着项目推进及人员的混杂，规范标准必须执行！

因此为了后期一劳永逸，需要制定统一标准，提交记录清晰明了，让团队一看就能知道此次提交的目的，减少管理时间成本。

正文
🥦目标分析
1.IDEA Git描述规范插件？
【git commit message helper】介绍
一个可帮助您标准化提交内容的插件
在这里插入图片描述
【git commit message helper】 使用
代码提交时，点击如下图标
在这里插入图片描述补充提交记录

在这里插入图片描述
2. Git提交描述格式规范解析
Git提交描述规则可以映射到插件下图部分，Header， Body，Footer
在这里插入图片描述
一个规范的Git提交描述格式如下

# Header头
<type>(<scope>): <subject>

# Body体
<body>

# Footer体
<footer>

1.Header头
Header头只有一行,包括3个字段: type(必需), scope(可选), subject(必需)
在这里插入图片描述
type 提交类型

type说明提交类型：只允许使用下面属性
在这里插入图片描述
scope 作用范围

scope说明提交影响范围：一般是修改的什么模块或者是什么功能，如【xx模块】/【xx功能】

subject 提交主题

subject 说明提交简短描述：一般是5-10各自简单描述做的任务，如【xx模块加入消息队列】

2.Body体
body说明提交详细描述：对于功能详细的描述，解释为什么加入这段代码，为什么调整优化等，如因分布式锁问题，导致死锁问题，优化调整xxxx

3.Footer脚
.Footer脚包括2个字段: Breaking Changes、Closed Issues
在这里插入图片描述
Breaking Changes

当前版本与之前版本不兼容，如迭代升级对之前版本不能做到兼容，就需要在Breaking Changes后面描述变动理由和迁移方法之类，此属性不常用

Closed Issues
当前 commit提交针对某个issue问题或者是禅道bug编号等，如Closes # 234

4.完成填充示例
在这里插入图片描述
3. 实例Git提交解析
举几个常用git提交描述案例

短信模块新功能提交
在这里插入图片描述
在这里插入图片描述
用户模块禅道bug1026修复提交
在这里插入图片描述
在这里插入图片描述
迭代SQL脚本提交
在这里插入图片描述
在这里插入图片描述

princeAladdin
关注
  • 4
    点赞
  • 踩
  • 9
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
Git提交说明规范
qq_40538274的博客
04-14 905
规范介绍 git commit信息格式介绍 type(scope): subject type(必须): commit 的类别，只允许使用下面几个标识： feat: 新的功能, fix: 修复Bug, docs: 只有文档变更, style: 空格, 分号等格式修复, refactor: 代码重构，注意和特性、修复区分开, perf: 提升性能, test: 添加测试, chore: 开发工具变动(构建、脚手架工具等), scope(可选)
Git提交规范结合实践
04-11
Git提交规范是软件开发团队协作中的重要组成部分，它有助于保持代码历史清晰，便于代码审查，回溯更改，以及自动化发布流程。以下是对标题和描述中所述知识点的详细说明： 1. **提交过程规范**： - **初始提交**：...
Git代码提交描述规范
栗少的博客
03-23 1796
我相信大家肯定还是会疑惑。这里就以我之前理解的 commit 规范为列子。希望起到一个抛砖引玉的作用。毕竟 commit 信息只是人为规范。不同公司，不同项目，不同人有着自己的见解。因为作者本身是一名爱岗敬业的 Android 程序员，可能提交日志相对于倾向于移动端，所以如果大家有更好的提交日志分享。这里非常欢迎在评论中看到你的回答~ 反面例子 在了解我的提交规范之前，我们来看一些反面的 commit 信息： 修改登录界面的Bug 修改空指针异常 增加提示 代码优化 调整UI 从上述 comm
git提交注释规范插件
苏叶的专栏
04-24 1578
1、前言 为什么要注重代码提交规范？ 在团队协作开发时，每个人提交代码时都会写 commit message。 每个人都有自己的书写风格，翻看我们组的git log, 可以说是五花八门，十分不利于阅读和维护。 一般项目开发都是多分支共存，master、develop、feature、hotfix、release等分支，在这么多分支中，我们会有一个稳定的master分支，但是我们需要将分支代码进行merge。存在规范的commit message可以帮助我们很轻松的合并代码以及发现问题。例如使用Jenkins
git提交说明规范
ScilogyHunter的博客
04-20 2107
意义 代码需要编程规范，提交也需要说明规范。简明扼要的提交说明能让自己和他人快速的了解每一次提交都对代码做了哪些重要变动，规范优秀的提交说明可以用于自动生成Change log(发布时用于说明版本差异)。混乱或无意义的提交说明只能降低效率并给人带来不严谨不牛逼的坏映象。 提交说明没有编程规范那么复杂，记住几个关键词和要点就可以写出优美的commit。 格式 提交说明大概分三部分，类型，范围和简要说...
【Git】提交代码详细流程
weixin_43644527的博客
02-28 1万+
问题一、误提交：提交代码时遇到冲突，但冲突文件并不想提交【一般可以通过将文件添加到.gitignore长久解决，但是由于我的文件具有线上版本，.gitignore文件不起作用】git add .git add .】：添加所有文件到暂存区】:将此次修改的所有文件退回到工作区。
Git 学习笔记——git 提交规范和 Github/Gitee 使用说明
un357951的博客
01-24 631
我们以vscode项目进行介绍访问https://github.com/microsoft/vscode 即可看到如下的界面页面的左上角：Star所以尽量不要像朋友圈集赞一样要求身边朋友刷starFork：Fork操作实际上是创建一个仓库的副本，并将仓库的upstream指向原仓库小问题：为什么要fork呢？为什么不直接push呢？fork方便了多人协作Watch：Watch操作可以向你的邮箱中推送该仓库的推送信息提示：如果不是特别重要的项目，不要随意点Watch，否则很容易邮箱被轰炸。
git文档说明描述
05-19
每次修改文件后，你可以用`git add`命令将更改暂存，然后通过`git commit`提交这些变更，附带一条描述性消息。这样，你就创建了一个新的版本。 3. **分支管理**：Git的分支模型是其强大之处。默认分支名为“master...
Git提交历史：Git提交历史
02-22
Git提交历史是Git版本控制系统中的一个重要概念，它记录了项目自始至终的所有变更，包括每次提交时对代码所做的修改、作者信息以及提交时的注释。了解如何查看和理解Git提交历史对于开发者来说至关重要，这能帮助...
gitAction:使用Git Graph JS描述的Git分支，提交，合并等
05-15
一个JavaScript库，用于在浏览器中绘制漂亮的git图。 项目页面： ： 如何开始您可以从库开始使用不同的选项： 。 克隆git clone git@github.com:nicoespeon/gitgraph.js.git ： git clone git@github....
Git提交消息：如何写一个好的git提交消息-python
06-18
Git提交消息：如何写一个好的git提交消息 Git 提交消息要编写出色的 git 提交消息，请查看这些指南和建议。 内容： 最高优先级 从简短的摘要行开始 继续进行更长的描述 摘要示例 摘要关键字 现实世界示例 使用语义...
规范 Git 提交说明
liangshanbo1215的博客
02-27 522
此外，不管是 Header 还是 Body，任何一行都不得超过 72 个字符（或 100 个字符），以避免自动换行影响美观。
Git 提交描述规范
qq_40174960的博客
02-03 1628
使用定义良好的 Git 提交消息可以格式增强团队协作并提高代码质量
【规范】看看人家Git提交描述，那叫一个规矩
JavaDog程序狗
03-08 1480
1.IDEA Git描述规范插件:git commit message helper 2.Git提交描述格式规范,type、scope、subject、body、footer内容分析 3.实例Git提交描述解析:新功能提交、bug修复、文档提交
Git提交规范
热门推荐
专注于大数据方向，区块链，前后端，数据可视化，人工智能等领域
06-23 1万+
以下规范参考Angular提交的规范。对于如何格式化git commit消息，我们有非常精确的规则。这导致更多 在浏览项目历史时，易于理解的可读信息。但同时 我们使用git commit消息来生成基于AngularJS提供的消息模板。1、commit message format消息格式每个提交消息由一个头、一个正文和一个页脚组成。header有一个特殊的 包含类型、范围和主题的格式。header是必填的，header的范围是可选的。提交消息的任何一行不能超过100个字符！
学习笔记——在IDEA中如何上传git以及git分支的拉取和提交
m0_64654458的博客
10-23 5860
此时创建的分支和master分支的内容一致，我们后续的操作可以在master分支以外的分支上操作。此时项目文件名变红 ，说明Git已检测到项目，但没有进行追踪，此时tom分支与 master相比，领先1个Commit。点击合并分支，此时tom分支和master分支内容一致。切换到lili分支，点击远程节点的master选择。此时项目文件名变绿 ，说明文件已添加到暂存区。选择源分支和目标分支以及标题和说明。此时，全部内容已完成！5.3 管理者审核和测试。点击分支-->创建分支。
IDEA中Git提交步骤（提交到中央仓库详细步骤）及使用操作注意事项
q_1092535160的博客
07-02 6173
Git+码云+IDEA使用步骤： 一、一定要先pull(先下载下来仓库的项目)等运行完毕 二、pull好之后，再add 三、add之后再点击add上边的Commit File 四、之后add上边的Commit File会变成Commit Directory点击 五、点击绿色的对勾，commit拍快照时点击commit and push 六、最后再push！ 相关文档参考：Git提交步骤 ...
git commit message 规范
哦豁灬
03-30 542
当前版本与之前版本不兼容，如迭代升级对之前版本不能做到兼容，就需要在Breaking Changes后面描述变动理由和迁移方法之类，此属性不常用。body说明提交详细描述：对于功能详细的描述，解释为什么加入这段代码，为什么调整优化等，如因分布式锁问题，导致死锁问题，优化调整xxxx。subject 说明提交简短描述：一般是5-10个字简单描述做的任务，如【xx模块加入消息队列】scope说明提交影响范围：一般是修改的什么模块或者是什么功能，如【xx模块】/【xx功能】在有新的 commit 的时候，在。
git提交commit
最新发布
06-21
Git 提交（Commit）是 Git 版本控制系统中的关键操作之一，用于保存代码的更改历史记录。当你对项目中的文件进行了修改、添加或删除后，需要将这些更改提交到仓库，以便跟踪项目的版本和协作。以下是提交 commit 的主要步骤： 1. **打开 Git 命令行或 Git 客户端**：首先确保你在项目的根目录中，或者已经通过 `cd` 命令切换到了正确的位置。 2. **查看当前状态**：使用 `git status` 命令检查哪些文件已更改、新增或被删除。 3. **暂存更改**：如果你想保留所有更改一起提交，可以使用 `git add .` 或指定具体文件名，如 `git add filename.txt`。如果你想一次只暂存某个特定的更改，可以使用 `git add modifiedfile.txt`。 4. **编写提交信息**：输入 `git commit -m "描述你的更改"`，这里的 `m` 后面跟着的是提交的简短说明，描述你这次更改的主要内容，这将作为 commit 的消息。 5. **验证和提交**：Git 会显示一个编辑器（通常是默认的文本编辑器），让你查看和编辑提交信息。确认无误后按 `Enter`，或者直接关闭编辑器（某些情况下，如果配置了 `-m` 参数，Git 会直接使用参数内容进行提交）。 6. **提交成功提示**：提交完成后，Git 会返回一个提交哈希值，表示这次更改已被添加到仓库的历史中。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

princeAladdin

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

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

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

打赏作者

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

抵扣说明：

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

余额充值