文档章节

编写良好的 git 提交信息

RoyceInWh
 RoyceInWh
发布于 2016/06/20 16:04
字数 652
阅读 2
收藏 0

编写一个良好的 git 提交信息

提交信息

我们作一次提交,都会提交相关的修改信息,一般这些信息当时都会仔细考虑留下应该留下的那些重要信息,比如为什么需要这次提交,提交解决什么问题等。

而且我们需要好好组织这些信息,一边以后查看,因为这些跟代码一样重要,他们是历史,就像课本一样,一旦留下错误的信息或者难以理解的信息,将会对

后来者,产生非常多的麻烦。

提交信息规范

一般来说,提交信息没有什么强制性的规范,但是希望大家遵循一些基本的规则,这些规则有利于大家正确表达提交内容,留下重要的信息,而忽略那些不必要

的内容。

实例

https://github.com/torvalds/subsurface

编写一个良好的提交信息:

Also, please write good git commit messages. A good commit message
looks like this:
 
Header line: explain the commit in one line (use the imperative)
 
Body of commit message is a few lines of text, explaining things
in more detail, possibly giving some background about the issue
being fixed, etc etc.
 
The body of the commit message can be several paragraphs, and
please do proper word-wrap and keep columns shorter than about
74 characters or so. That way "git log" will show things
nicely even when it's indented.
 
Make sure you explain your solution and why you're doing what you're
doing, as opposed to describing what you're doing. Reviewers and your
future self can read the patch, but might not understand why a
particular solution was implemented.
 
Reported-by: whoever-reported-it
Signed-off-by: Your Name <youremail@yourhost.com>
 
where that header line really should be meaningful, and really should be
just one line. That header line is what is shown by tools like gitk and
shortlog, and should summarize the change in one readable line of text,
independently of the longer explanation. Please use verbs in the
imperative in the commit message, as in "Fix bug that...", "Add
file/feature ...", or "Make Subsurface..."
 
一次良好的提交信息应该包含一个信息头,尽量用一行文字总结那些必要信息

然后空下一行,

接着写下关于这次提交的具体内容,有关修复bug的背景等等,尽量表达你为什么

要做这次提交而不是你正在作什么提交。这样被人才能很好的理解而不会弄不清楚

为什么需要这个东西。所有的提交内容保持在74个字符之内,这样才能被 git log

正常的显示,而不会超过屏幕。

下面是一些: 提交者信息,或者其他信息,一般都是 git 里面需要的代码编写者或者

测试者名字和邮箱,具体参考 git 。




本文转载自:http://blog.csdn.net/jingxia2008/article/details/41290837

RoyceInWh

RoyceInWh

粉丝 5
博文 240
码字总数 1282
作品 0
武汉
程序员
私信 提问
良好Git协作之Pull Requests实践

我们知道Git协作中最重要的一个步骤是Pull Requests(简称PR,Gitlab中也叫Merge requests,MR,本文中统一叫PR),在之前的文章"理清基本的git(github)"流程中,虫虫介绍过基于Fork-PR的开发...

虫虫猎奇ccsearchit
2018/10/31
0
0
您必须知道的 Git 分支开发规范

Git 是目前最流行的源代码管理工具。 为规范开发,保持代码提交记录以及 git 分支结构清晰,方便后续维护,现规范 git 的相关操作。 分支管理 master 分支 master 为主分支,也是用于部署生产...

VincentSea
2018/07/10
0
0
关于Git提交信息的一点建议

我想花点时间阐述是什么造就了良好的信息提交。我认为提交信息格式优良体验及一些小细节是Git成功的原因。第一次rails.git提交提示信息有点长是可以理解的,但这是一个坏的实现,下面我来说明...

halfcoder
2013/07/12
1K
0
[译] Commit 提交指南

原文地址:Commit messages guide 原文作者:RomuloOliveira 译文出自:掘金翻译计划 本文永久链接:github.com/xitu/gold-m… 译者:Mirosalva 校对者:Chorer,zoomdong 一份理解 commit 信...

niithub
05/11
13
0
如何构建你自己的 Git 服务器

导读: 第一部分:什么是Git 第二部分:开始使用Git 第三部分: 创建您的第一个Git存储器 第四部分:如何在Git中恢复旧版本文件 第五部分:Git的三种图形工具 第六部分:如何构建你自己的Git...

oschina
2016/08/10
7.9K
13

没有更多内容

加载失败,请刷新页面

加载更多

哪些情况下适合使用云服务器?

我们一直在说云服务器价格适中,具备弹性扩展机制,适合部署中小规模的网站或应用。那么云服务器到底适用于哪些情况呢?如果您需要经常原始计算能力,那么使用独立服务器就能满足需求,因为他...

云漫网络Ruan
今天
5
0
Java 中的 String 有没有长度限制

转载: https://juejin.im/post/5d53653f5188257315539f9a String是Java中很重要的一个数据类型,除了基本数据类型以外,String是被使用的最广泛的了,但是,关于String,其实还是有很多东西...

低至一折起
今天
17
0
OpenStack 简介和几种安装方式总结

OpenStack :是一个由NASA和Rackspace合作研发并发起的,以Apache许可证授权的自由软件和开放源代码项目。项目目标是提供实施简单、可大规模扩展、丰富、标准统一的云计算管理平台。OpenSta...

小海bug
昨天
11
0
DDD(五)

1、引言 之前学习了解了DDD中实体这一概念,那么接下来需要了解的就是值对象、唯一标识。值对象,值就是数字1、2、3,字符串“1”,“2”,“3”,值时对象的特征,对象是一个事物的具体描述...

MrYuZixian
昨天
9
0
解决Mac下VSCode打开zsh乱码

1.乱码问题 iTerm2终端使用Zsh,并且配置Zsh主题,该主题主题需要安装字体来支持箭头效果,在iTerm2中设置这个字体,但是VSCode里这个箭头还是显示乱码。 iTerm2展示如下: VSCode展示如下: 2...

HelloDeveloper
昨天
9
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部