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

[Eugene Sandulenko]

I usually write it in this way:

  COMMIT: Do something useful. Fixes bug #123: "ScummVM is not doing
anything useful"

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:

   COMMIT: Do something useful and elaborate about the purpose.

   Fixes bug #123: "ScummVM is not doing anything useful"


Eugene

On 23 March 2016 at 14:50, Willem Jan Palenstijn <wjp at usecode.org> wrote:

> 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
>
>
> ------------------------------------------------------------------------------
> 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
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.scummvm.org/pipermail/scummvm-devel/attachments/20160323/ca806758/attachment.html>