<div dir="ltr">I usually write it in this way:<div><br></div><div>  COMMIT: Do something useful. Fixes bug #123: "ScummVM is not doing anything useful"</div><div><br></div><div>Thus, I have both the commit id and the message. If it doesn't fit in 80 characters, then the commit info goes into the extras:</div><div><br></div><div>   COMMIT: Do something useful and elaborate about the purpose.</div><div><br></div><div>   Fixes bug #123: "ScummVM is not doing anything useful"</div><div><br></div><div><br></div><div>Eugene</div></div><div class="gmail_extra"><br><div class="gmail_quote">On 23 March 2016 at 14:50, Willem Jan Palenstijn <span dir="ltr"><<a href="mailto:wjp@usecode.org" target="_blank">wjp@usecode.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Hi,<br>
<br>
Thanks, this will be a useful addition. I have a slight preference for<br>
"bug #123". (So for example a line "This fixes bug #123.")<br>
<br>
The reasoning for not putting it in the first line is that is not useful<br>
information when scanning through commits, since having to look up a bug online<br>
defeats the purpose of quickly seeing what a commit is about.<br>
<span class="HOEnZb"><font color="#888888"><br>
-Willem Jan<br>
</font></span><div class="HOEnZb"><div class="h5"><br>
<br>
On Wed, Mar 23, 2016 at 03:46:39PM +0200, Ori Avtalion wrote:<br>
> This has come up as a question in IRC, and I realized the guidelines<br>
> [1] don't mention it specifically:<br>
><br>
> If a commit fixes a particular bug, it should be mentioned somewhere<br>
> in the commit message.<br>
> Looking at the commit history, it seems to always be in the detailed<br>
> description of the commit, and not on the first line.<br>
><br>
> Should bugs be specified as "bug #123" or just "#123"?<br>
><br>
> [1] <a href="http://wiki.scummvm.org/index.php/Commit_Guidelines" rel="noreferrer" target="_blank">http://wiki.scummvm.org/index.php/Commit_Guidelines</a><br>
><br>
> ------------------------------------------------------------------------------<br>
> Transform Data into Opportunity.<br>
> Accelerate data analysis in your applications with<br>
> Intel Data Analytics Acceleration Library.<br>
> Click to learn more.<br>
> <a href="http://pubads.g.doubleclick.net/gampad/clk?id=278785351&iu=/4140" rel="noreferrer" target="_blank">http://pubads.g.doubleclick.net/gampad/clk?id=278785351&iu=/4140</a><br>
> _______________________________________________<br>
> Scummvm-devel mailing list<br>
> <a href="mailto:Scummvm-devel@lists.sourceforge.net">Scummvm-devel@lists.sourceforge.net</a><br>
> <a href="https://lists.sourceforge.net/lists/listinfo/scummvm-devel" rel="noreferrer" target="_blank">https://lists.sourceforge.net/lists/listinfo/scummvm-devel</a><br>
<br>
------------------------------------------------------------------------------<br>
Transform Data into Opportunity.<br>
Accelerate data analysis in your applications with<br>
Intel Data Analytics Acceleration Library.<br>
Click to learn more.<br>
<a href="http://pubads.g.doubleclick.net/gampad/clk?id=278785351&iu=/4140" rel="noreferrer" target="_blank">http://pubads.g.doubleclick.net/gampad/clk?id=278785351&iu=/4140</a><br>
_______________________________________________<br>
Scummvm-devel mailing list<br>
<a href="mailto:Scummvm-devel@lists.sourceforge.net">Scummvm-devel@lists.sourceforge.net</a><br>
<a href="https://lists.sourceforge.net/lists/listinfo/scummvm-devel" rel="noreferrer" target="_blank">https://lists.sourceforge.net/lists/listinfo/scummvm-devel</a><br>
</div></div></blockquote></div><br></div>