Git新手教程-日志提交规范(五)补充

本文详述了Git提交信息的规范,强调了其重要性,并提供了一个完整的日志结构模板,包括标题的类型、项目组信息、Bug/需求Id等。通过反面例子展示了不清晰的提交信息问题,接着介绍了规范化的提交标题和消息体,包括功能开发、Bug修复、文档与样式修改的示例,提醒了在提交时应注意的事项。
摘要由CSDN通过智能技术生成
2824145-901499b32360b1e6.jpg
title.jpg

前言

如果大家学习了之前的文章Git新手教程-向仓库中添加commit(五),我相信大家肯定还会为如何提交一个比较规范的 commit 信息而烦恼,虽然我们在上面的文章中介绍了两篇相关的文章:

我相信大家肯定还是会疑惑。这里就以我之前理解的 commit 规范为列子。希望起到一个抛砖引玉的作用。毕竟 commit 信息只是人为规范。不同公司,不同项目,不同人有着自己的见解。因为作者本身是一名爱岗敬业的 Android 程序员,可能提交日志相对于倾向于移动端,所以如果大家有更好的提交日志分享。这里非常欢迎在评论中看到你的回答~

反面例子

在了解我的提交规范之前,我们来看一些反面的 commit 信息:

  • 修改登录界面的Bug
  • 修改空指针异常
  • 增加提示
  • 代码优化
  • 调整UI

从上述 commit 信息中,我相信大家已经看出一些问题,就是这些 commit 消息意图都指代不明。我们根本能从这些 commit 中知道,到底是为了解决什么问题而提交的。

就拿 "修改登录界面的Bug” 来说,到底登录界面有什么 Bug ?就不能写清楚吗? "修改空指针异常”,哪个界面的空指针?导致空指针的原因,又是什么呢?

这个时候你可能会说:"我们可以查看 commit 对应所提交的文件, 你看修改的文件不就知道我干了什么吗?" 对࿰

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值