Re: Best practices/conventions for tags and references in commit message

From: Christian Couder <christian.couder@gmail.com>
Date: Jun 5, 2014, 16:47 UTC
Message-ID: <CAP8UFD3MQ_BEyZFL2oE=KCGnZrCW5-NzXnVaaAg_6HMBAN-8hA@mail.gmail.com>
In-Reply-To: <201406051610.41373.thomas@koch.ro>

On Thu, Jun 5, 2014 at 4:10 PM, Thomas Koch <thomas@koch.ro> wrote:

Show 6 quoted lines

> On Tuesday, May 27, 2014 03:49:24 PM Johan Herland wrote:
>> Search the mailing list archives for git-interpret-trailers. It's coming.
> Nice!
>
> I started a table to collect how different projects or tools use trailers:
> https://git.wiki.kernel.org/index.php/CommitMessageConventions#Trailers

Great!

It would be even better if you could add links to one or more actual commits that contain the specified trailer.

For example for openstack, it would be nice to have real examples of DocImpact, SecurityImpact and UpgradeImpact.

> It would be nice to see more examples and in the long run to have some best
> practices recommended by gits documentation and supported across different bug
> trackers, changelog generators, statistic generators, repository viewers,
> etc..

Yeah, what is also interesting is that some people/projects/tools use things that are in some ways trailer like. For example GitHub parses commit messages for things like "fix #1234" and there are also people adding refs at the end of commit messages like:

[1] http://www.example.com/example_ref.html

Thanks, Christian.