[Scummvm-devel] Commit guidelines - how to specify fixed bug numbers?

[Willem Jan Palenstijn]

Hi,

Thanks, this will be a useful addition. I have a slight preference for
"bug #123". (So for example a line "This fixes bug #123.")

The reasoning for not putting it in the first line is that is not useful
information when scanning through commits, since having to look up a bug online
defeats the purpose of quickly seeing what a commit is about.

-Willem Jan


On Wed, Mar 23, 2016 at 03:46:39PM +0200, Ori Avtalion wrote:
> This has come up as a question in IRC, and I realized the guidelines
> [1] don't mention it specifically:
> 
> If a commit fixes a particular bug, it should be mentioned somewhere
> in the commit message.
> Looking at the commit history, it seems to always be in the detailed
> description of the commit, and not on the first line.
> 
> Should bugs be specified as "bug #123" or just "#123"?
> 
> [1] http://wiki.scummvm.org/index.php/Commit_Guidelines
> 
> ------------------------------------------------------------------------------
> Transform Data into Opportunity.
> Accelerate data analysis in your applications with
> Intel Data Analytics Acceleration Library.
> Click to learn more.
> http://pubads.g.doubleclick.net/gampad/clk?id=278785351&iu=/4140
> _______________________________________________
> Scummvm-devel mailing list
> Scummvm-devel at lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/scummvm-devel