码迷,mamicode.com
首页 > 其他好文 > 详细

怎样写合理的git-commit消息

时间:2015-10-25 20:57:03      阅读:203      评论:0      收藏:0      [点我收藏+]

标签:

在一个并不存在的网站上闲逛时,发现有人推荐了一篇关于Git提交日志的文章。对于刚使用GitHub和Gitlab没多久的我来说,具有很好的指导意义。

首先,原文地址:http://chris.beams.io/posts/git-commit/

文章里讲到,一个团队,成员提交git日志的方式应该是一样,没有什么差别的。为了创建一个有用的修订代码的历史记录,关于commit message,团队应约定至少三件事情:

1. 格式。Markup syntax,wrap margins,grammar,大小写,标点符号。按约定的格式去写,而不是个人臆想,并且尽可能的使提交日志简单。这样做的结果就是得到一个非常统一的日志,不仅能让人乐于读它,而且还能使人定期去读。

2. 内容。在做git提交的时候,需要知道哪些信息是需要包含在提交的主体里面的, 而哪些又是不需要的!

3. 数据信息。Issue的ID,Pull request数等等,这些数据信息怎么被引用!

幸运的是,已经有了完善的约定来完成一个地地道道的git提交日志。一共有七条:

1. 使用空白行将主题(subject)和主体部分(body)分开;

2. 将主题行限制在50字符以内;

3. 主题行的第一个字母大写;

4. 主题行不要以句号结尾;

5. 主题行使用祈使语句;

6. 主体部分在72字符以内;

7. 主体部分用来解释是什么/做了什么(what),为什么(why),而不是怎样做的(how)

怎样写合理的git-commit消息

标签:

原文地址:http://www.cnblogs.com/Yaxian/p/4909418.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!