实用Java—如何不写Git提交消息

抽丝剥茧 细说架构那些事——【优锐课】

我正在撰写一篇文章,概述如何编写良好的Git提交消息,以及开发人员应遵循的各种Git提交消息约定和规则。但是,当我撰写有关开发人员应遵循的最佳实践的文章时,我经常发现自己在内部讨论开发人员不应做什么。

我希望原始文章包含最佳实践列表,而不是不要做的事情。 因此,我从中删除了Git commit最坏实践部分,并决定在此处列出。


Git提交反模式

是什么导致不良的Git提交消息?开发人员不应该做什么?这是我的十大清单:

1、主题行不得超过50个字符。 简洁地描述任何Git提交应该很容易。

2、注释提交时,不要使用被动语态或过去式。始终使用主动声音。

3、不要在主题行中添加不必要的大写字母。除了大写的标准规则,仅将主题行中第一个单词的首字母大写。绝对不要大声疾呼,更不要说大惊小怪了,更不要说SCREAMING_SNAKE_CASE。另外,请勿在主题行末尾加句号。

4、不要尝试用多余的星号,“&”号和井号标记来格式化提交消息。

5、不要忘记,进行故障排除的人可能会使用无法自动执行文本换行的Unix实用程序。取而代之的是,在正文中及其周围的70个字符标记处添加回车符。

6、不要描述你编写的底层代码。如果有人想看一下你编写的代码,他们会做一个git diff。提交消息应描述上下文和目的,而不是实现。

7、不要忘记用完整的回车分隔提交主体和主题行。

8、不要只是在提交中引用JIRA票证。人们不必打开错误跟踪工具即可知道为什么要对代码库进行更改。

9、即使你不推分支,也不要对团队的另一名成员说脏话。本地提交趋向于意外地使其成为中央代码库。 “我的白痴团队领导使我做到了”这一主题行可能不会在你的年度审核中顺利进行。

10、不要在提交内容中进行任何恶作剧。无论你的散文多么出色,TAGRI规则始终适用于软件开发领域。

感谢你阅读这篇短文章。对Java感兴趣的同学如果在学习如果过程中有任何疑问可以加入Java学习资料交流qq群:907135806,欢迎进群探讨。也可以添加vx:ddmsiqi,有更多JVM、Mysql、Tomcat、Spring Boot、Spring Cloud、Zookeeper、Kafka、RabbitMQ、RockerMQ、Redis、ELK、Git等Java学习资料和视频课程!

推荐阅读更多精彩内容

  • 前言:教程来源于Udacity的免费教程-用Git进行版本控制,这里仅是个人的笔记,参考使用。 git tag:给...
    地坛公园阅读 445评论 0赞 1
  • 简介 Git是一个开源的分布式版本控制系统,用于敏捷高效地处理任何或小或大的项目。 Git 与常用的版本控制工具 ...
    闽越布衣阅读 1,105评论 0赞 17
  • 版本控制 版本控制就是控制版本,版本控制系统帮助控制(管理)某个事物(通常指源代码)的不同版本现在流行的版本控制:...
    徐凯_xp阅读 315评论 0赞 1
  • 一 自从春节期间,我就开始纳闷一件事:我家的醋怎么变了味儿? 吃饺子时,我和女儿都喜欢蘸点醋。 可是,这一段时间以...
    高英_原创作者阅读 27评论 0赞 2
  • 珍惜一个人,一定感动过。放弃一个人,一定失望过。看人不能看表面,日久必现原形。 真正的朋友,是在最黑暗的时候,陪你...
    安筱酒阅读 90评论 4赞 1