热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

编写良好的提交信息:实用指南

要创建有用的修订历史记录,团队应该首先就要使用的提交消息约定达成一致,这也适用于个人项目。最近,我在Hashnode上问了一个问题

要创建有用的修订历史记录,团队应该首先就要使用的提交消息约定达成一致,这也适用于个人项目。

最近,我在Hashnode上问了一个问题,询问用户 他们在工作中使用哪种提交消息约定? ”,当用户解释他们在工作中以及用于个人项目的约定时,我得到了相当多的反响。

在本文中,我将介绍为什么您应该编写良好的提交消息以及如何编写良好的提交消息。

Git版本控制简介

版本控制软件是每天现代软件开发人员实践中必不可少的部分。

到目前为止, Git是当今世界上使用最广泛的现代版本控制系统。 它是一个分布式且积极维护的开源项目,最初由Linux操作系统内核的著名创建者Linus Torvalds于2005年开发。

刚接触Git? 查看官方的入门指南或我过去的演讲中的这张幻灯片 。

什么是提交消息?

在Git中暂存后,使用commit命令将更改保存到本地存储库。 但是,在保存Git更改之前,您必须告诉Git您要保存哪些更改,因为您可能已经进行了大量更改。 做到这一点的一种好方法是添加一个提交消息以标识您的更改。

提交选项

  • -m <消息>

此选项设置提交的消息。

git add static/admin/config.yml
git commit -m "Setup multiple roles for netlify-cms git gateway"

  • -a或--all

此选项自动提交所有&#xff08;包括新的&#xff09;跟踪&#xff0c;修改或删除的文件。

git commit - a -m "Add a new role for netlify-cms git gateway"

  • - 修改

此选项将使用当前已暂存的任何更改或新的提交消息重写最后的提交&#xff0c;并且仅应在尚未推送到远程存储库的提交上执行。

git add .
git commit --amend -m "Update roles for netlify-cms git gateway"

为什么要编写良好的提交消息&#xff1f;

您可能会说“这只是一个个人项目”&#xff0c;但是是的&#xff0c;您现在一个人工作&#xff0c;但是当您与团队合作或为开源做贡献时会发生什么&#xff1f;

精心设计的Git提交消息是与从事该项目的其他开发人员以及您未来的自我沟通有关变更的上下文的最佳方法。 您是否尝试过运行旧项目之一的&#96;git log&#96;来查看自开始以来就使用过的“怪异”提交消息&#xff1f; 您很难解释过去为什么要进行一些更改&#xff0c;并且希望您现在之前已经阅读过本文&#xff1a;)。

提交消息可以充分告诉您为什么进行了更改&#xff0c;并且了解为什么进行了更改可以使开发和协作更加高效。

如何使用Git编写提交消息

在此之前&#xff0c;我只在个人项目上使用了git commit -m "Fix X to allow Y to use Z" &#xff0c;并且仅提供了一个主题&#xff0c;没有附加描述。 这非常适合进行小而清晰的修复&#xff0c;例如git commit -m "Fix typo in README.md中的git commit -m "Fix typo in README.md但是在更广泛的更改的情况下&#xff0c;您需要添加一些额外的细节。

编辑器方法

运行没有消息或选项的git commit &#xff0c;它将打开您的默认文本编辑器以编写提交消息。

>要配置“默认”编辑器&#xff1a;

git config --global core.editor nano

这会将git配置为使用nano作为默认编辑器。 将“ nano”替换为“ emacs”&#xff0c;“ vim”或您的偏好。

在打开的编辑器中&#xff0c;第一行是主题&#xff08;简短描述&#xff09;&#xff0c;其后留空行&#xff0c;其他所有内容都是扩展描述&#xff08;正文&#xff09;。

change ( s ) in around 50 characters or less >
detailed explanatory description of the change wrapped into about 72
characters >

命令行方式

git commit -m "Subject" -m "Description..."

第一个-m选项是主题&#xff08;简短描述&#xff09;&#xff0c;第二个是扩展描述&#xff08;正文&#xff09;。

如何编写良好的提交消息

一些团队和开发人员使用多种约定来编写良好的提交消息。 我只概述一些用于编写提交消息的一般规则和技巧&#xff0c;您将不得不决定要遵循的约定&#xff0c;并且如果您在公司工作或为开源做贡献&#xff0c;则必须适应它们的约定&#xff1a;)。

为了保持一致性&#xff0c;您可以在工作中使用一种约定&#xff0c;而在个人项目中使用另一种约定&#xff0c;因为您有时可能会更改工作&#xff0c;并且约定可能会更改。

确保检查此线程以了解一些惊人的提交消息约定&#xff0c;或添加您的约定以帮助某人做出决定。

这是Tim Pope最初编写的良好提交消息的一个很好的模板

大写的简短&#xff08;不超过50个字符&#xff09;摘要
如有必要&#xff0c;提供更详细的说明文字。 将其包装到大约72个字符左右。 在某些情况下&#xff0c;第一行被视为电子邮件的主题&#xff0c;其余文本被视为正文。 将摘要与正文分开的空白行很重要&#xff08;除非您完全省略正文&#xff09;&#xff1b; 如果将两者一起运行&#xff0c;诸如rebase之类的工具可能会感到困惑。
请务必将提交消息写在“修复错误”而不是“修复错误”或“修复错误”中。 该约定与git merge和git revert等命令生成的提交消息匹配。
空白段之后是其他段落。
-子弹点也可以
-通常在项目符号上使用连字符或星号&#xff0c;后跟一个空格&#xff0c;中间留有空白行&#xff0c;但约定在此处有所不同
-使用悬挂式缩进
如果您使用问题跟踪器&#xff0c;请在其底部添加一个引用&#xff0c;如下所示&#xff1a;解决&#xff1a;&#xff03;123

看起来不错吧&#xff1f; 您也可以通过以下方法使自己的实力变得出色&#xff1a;

  1. 1.指定提交类型&#xff1a;

  • 壮举 &#xff1a;您要添加到特定应用程序的新功能
  • fix &#xff1a;一个错误修复
  • 样式 &#xff1a;与样式相关的功能和更新
  • 重构 &#xff1a;重构代码库的特定部分
  • 测试 &#xff1a;与测试相关的所有内容
  • docs &#xff1a;与文档相关的所有内容
  • 杂务 &#xff1a;常规代码维护。
  1. [您也可以使用表情符号来代表提交类型]

    2.用空白行将主体与身体分开

    3.您的提交消息不应包含任何空格错误

    4.删除不必要的标点符号

    5.不要以句号结尾主题行

    6.大写主题行和每个段落

    7.在主题行中使用祈使语气

    8.用正文解释您进行了哪些更改以及进行更改的原因。

    9.不要以为审阅者了解原始问题是什么&#xff0c;请确保将其添加。

    10.不要认为您的代码是不言自明的

    11.遵循团队定义的提交约定

结论

提交消息最​​重要的部分是它应该清晰且有意义。 从长远来看&#xff0c;编写良好的提交消息可以表明您有多大协作者&#xff0c;而编写良好的提交消息所带来的好处不仅限于您的团队&#xff0c;而且还不仅限于您自己&#xff0c;还包括未来的贡献者。

想要了解有关Git的更多信息并成为专业的“版本控制器”&#xff0c;请查看以下优秀资源&#xff1a;

  • https://try.github.io/
  • https://git-scm.com/book/zh/v2
  • https://www.git-tower.com/learn/
  • https://learngitbranching.js.org/xxxx

先前发布在https://bolajiayodeji.com/writing-good-commit-messages-a-practical-guide-ck3izs56t00sed0s11z515m1j

From: https://hackernoon.com/writing-good-commit-messages-a-practical-guide-1j11i3y4c



推荐阅读
  • MySQL索引详解与优化
    本文深入探讨了MySQL中的索引机制,包括索引的基本概念、优势与劣势、分类及其实现原理,并详细介绍了索引的使用场景和优化技巧。通过具体示例,帮助读者更好地理解和应用索引以提升数据库性能。 ... [详细]
  • 本文详细介绍了 Dockerfile 的编写方法及其在网络配置中的应用,涵盖基础指令、镜像构建与发布流程,并深入探讨了 Docker 的默认网络、容器互联及自定义网络的实现。 ... [详细]
  • 如何配置Unturned服务器及其消息设置
    本文详细介绍了Unturned服务器的配置方法和消息设置技巧,帮助用户了解并优化服务器管理。同时,提供了关于云服务资源操作记录、远程登录设置以及文件传输的相关补充信息。 ... [详细]
  • 使用Vultr云服务器和Namesilo域名搭建个人网站
    本文详细介绍了如何通过Vultr云服务器和Namesilo域名搭建一个功能齐全的个人网站,包括购买、配置服务器以及绑定域名的具体步骤。文章还提供了详细的命令行操作指南,帮助读者顺利完成建站过程。 ... [详细]
  • 深入理解Redis的数据结构与对象系统
    本文详细探讨了Redis中的数据结构和对象系统的实现,包括字符串、列表、集合、哈希表和有序集合等五种核心对象类型,以及它们所使用的底层数据结构。通过分析源码和相关文献,帮助读者更好地理解Redis的设计原理。 ... [详细]
  • 本文详细介绍如何使用Python进行配置文件的读写操作,涵盖常见的配置文件格式(如INI、JSON、TOML和YAML),并提供具体的代码示例。 ... [详细]
  • 本文详细介绍了如何在Linux系统上安装和配置Smokeping,以实现对网络链路质量的实时监控。通过详细的步骤和必要的依赖包安装,确保用户能够顺利完成部署并优化其网络性能监控。 ... [详细]
  • CentOS7源码编译安装MySQL5.6
    2019独角兽企业重金招聘Python工程师标准一、先在cmake官网下个最新的cmake源码包cmake官网:https:www.cmake.org如此时最新 ... [详细]
  • 本文深入探讨了Linux系统中网卡绑定(bonding)的七种工作模式。网卡绑定技术通过将多个物理网卡组合成一个逻辑网卡,实现网络冗余、带宽聚合和负载均衡,在生产环境中广泛应用。文章详细介绍了每种模式的特点、适用场景及配置方法。 ... [详细]
  • 从 .NET 转 Java 的自学之路:IO 流基础篇
    本文详细介绍了 Java 中的 IO 流,包括字节流和字符流的基本概念及其操作方式。探讨了如何处理不同类型的文件数据,并结合编码机制确保字符数据的正确读写。同时,文中还涵盖了装饰设计模式的应用,以及多种常见的 IO 操作实例。 ... [详细]
  • 本文介绍了如何通过 Maven 依赖引入 SQLiteJDBC 和 HikariCP 包,从而在 Java 应用中高效地连接和操作 SQLite 数据库。文章提供了详细的代码示例,并解释了每个步骤的实现细节。 ... [详细]
  • 使用Python在SAE上开发新浪微博应用的初步探索
    最近重新审视了新浪云平台(SAE)提供的服务,发现其已支持Python开发。本文将详细介绍如何利用Django框架构建一个简单的新浪微博应用,并分享开发过程中的关键步骤。 ... [详细]
  • MySQL 数据库迁移指南:从本地到远程及磁盘间迁移
    本文详细介绍了如何在不同场景下进行 MySQL 数据库的迁移,包括从一个硬盘迁移到另一个硬盘、从一台计算机迁移到另一台计算机,以及解决迁移过程中可能遇到的问题。 ... [详细]
  • Scala 实现 UTF-8 编码属性文件读取与克隆
    本文介绍如何使用 Scala 以 UTF-8 编码方式读取属性文件,并实现属性文件的克隆功能。通过这种方式,可以确保配置文件在多线程环境下的一致性和高效性。 ... [详细]
  • GIMP 2.99.2 发布:UI 采用 GTK3 实现、原生支持高分屏和 Wayland
    开源项目评选最后一周,手里的5票再不用就没用了https:www.oschina.netprojecttop_cn_2020GIMP2.99.2已发布,同时这也标志着GIMP3.0的到来,其中最显著的变化是从GTK2过渡到GTK3工具包。基于 ... [详细]
author-avatar
Lanboream
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有