您的提交消息使用哪种样式?技术或功能为基础?

时间:2011-11-21 08:06:08

标签: git svn coding-style

假设您正在处理某种类型的Web应用程序。以下是同一更改集的2个不同版本的提交消息。

  1. 将用户重定向到user_profile以获取公共控制器 - 或 - 限制登录用户对公共控制器的访问
  2. 在过滤到必要的控制器之前添加require_guest
  3. 第一个解释了这个变化的结果,第二个解释了你是如何实现这个或你改变了什么。

    那你更喜欢哪一个?为什么?

3 个答案:

答案 0 :(得分:4)

DRY适用于提交消息,因此不要重复从代码/ diff中看到的任何内容。

创建上下文:提及导致更改的故障单编号,解释您执行此操作的原因,提供10,000英尺的更改视图。

示例:“确保只有经过验证的用户才能访问私有页面”而不是“添加对AccessController的调用”。我可以从差异中看到后者,但差异并没有解释你为何做了改变。

答案 1 :(得分:1)

我宁愿有一条提交消息提到连接的两个端:

New require_guest before filter redirects users to
user_profile for public controllers

答案 2 :(得分:0)

如果你使用Trac或RedMine这样的话,你应该提及这两个票号,