threads / discuss / 36760

Best practices/conventions for tags and references in commit message

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

## tl;dr

4 messages between May 27, 2014 and Jun 5, 2014.

replies: 3people: 3as markdown or json

Thomas Koch· May 27, 2014, 11:26 UTC · lore

Hi,

different projects or tools have conventions to include machine parsable information in commit messages, e.g.:

Closes: #42
Thanks: my mother, my wife
Git-Dch: Ignore
Commit-Id: 50M3R34LLYR4ND0MB1TSANDNUMB3R5

(see thread: "RFE: support change-id generation natively" for Commit-Id) ("Git-Dch: Ignore" ecludes the commit from the changelog)

Are you aware of any convention or best practices for such tags that are used in more than one project? Are there more tags like these?

Maybe it would also be helpful to have some more plumbing support from Git for such tags. But I've not yet thought enough about this.

Best regards, Thomas Koch

Johan Herland· May 27, 2014, 13:49 UTC · re: Thomas Koch · lore

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

Search the mailing list archives for git-interpret-trailers. It's coming. :)

...Johan

On Tue, May 27, 2014 at 1:26 PM, Thomas Koch <thomas@koch.ro> wrote:

Show 24 quoted lines

> Hi,
>
> different projects or tools have conventions to include machine parsable
> information in commit messages, e.g.:
>
> Closes: #42
> Thanks: my mother, my wife
> Git-Dch: Ignore
> Commit-Id: 50M3R34LLYR4ND0MB1TSANDNUMB3R5
>
> (see thread: "RFE: support change-id generation natively" for Commit-Id)
> ("Git-Dch: Ignore" ecludes the commit from the changelog)
>
> Are you aware of any convention or best practices for such tags that are used
> in more than one project? Are there more tags like these?
>
> Maybe it would also be helpful to have some more plumbing support from Git for
> such tags. But I've not yet thought enough about this.
>
> Best regards, Thomas Koch
> --
> To unsubscribe from this list: send the line "unsubscribe git" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html

-- 
Johan Herland, <johan@herland.net>
www.herland.net

Thomas Koch· Jun 5, 2014, 14:10 UTC · re: Johan Herland · lore

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

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

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..

Regards,

Thomas Koch

Christian Couder· Jun 5, 2014, 16:47 UTC · re: Thomas Koch · lore

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

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.