I actually prefer bug numbers in the header.

When looking at the gerrit dashboard it's useful to see from the
commit message whether it is a bug or enhancement to determine what
code I should review first (bugs always win).

I also tend to write very verbose commit messages so I like to put the
bug in the header so the message itself can be ignored if necessary.

Apologies in advanced if I have started another bike shed conversation.. :D

On Fri, Mar 1, 2013 at 1:46 PM, Chad <[email protected]> wrote:
> Hi,
>
> This is a friendly reminder to everyone about the preferred way to
> link to bugs in your commit messages. When you include them as
> part of the footer, they are indexed and are thus searchable. For
> example:
>
> """
> Fixing some weird bug
>
> More explanation
> Blah blah blah.
>
> Bug: 1234
> Change-Id: Ia90.....
> """
>
> So when you do this, you're able to search for "bug:1234" via Gerrit.
> By doing this, you're also removing it from the first line (which was
> our old habit, mostly from SVN days), providing you more space to
> be descriptive in that first line.
>
> -Chad
>
> _______________________________________________
> Wikitech-l mailing list
> [email protected]
> https://lists.wikimedia.org/mailman/listinfo/wikitech-l



-- 
Jon Robson
http://jonrobson.me.uk
@rakugojon

_______________________________________________
Wikitech-l mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/wikitech-l

Reply via email to