conventionalcommits.org icon indicating copy to clipboard operation
conventionalcommits.org copied to clipboard

Adding ticket links (jira ids/git lab ids etc)

Open dagadbm opened this issue 5 years ago • 8 comments

How would you guys go around still using conventional commits AND also allow to insert the ticket jira id the commit is associated with?

in what part of the commit structure would this go?

dagadbm avatar Feb 21 '20 10:02 dagadbm

Hey @dagadbm I do it every time actually! You can use the footer to link the Jira issues :) An example (just fill it with real content 😂 ):

    feat(pkg): add an amazing feature
   
    This feature will make us so cool!

    [TICKET-1545](https://yourcompany.atlassian.net/browse/TICKET-1545)

damianopetrungaro avatar Feb 21 '20 11:02 damianopetrungaro

@damianopetrungaro the problem is you're not following the specification for the footer, which requires a : separator

lppedd avatar Apr 10 '20 22:04 lppedd

@lppedd where is it mentioned in the spec? It isn't specified as far as I can see

damianopetrungaro avatar Apr 10 '20 23:04 damianopetrungaro

@damianopetrungaro yeah you're right. It's only for BREAKING CHANGE.

OT: so let's say we have the example

fix: correct minor typos in code

see the issue for details

on typos fixed.

Reviewed-by: Z

And we remove the : from the footer.
How do we discern it from the body?

lppedd avatar Apr 11 '20 00:04 lppedd

@damianopetrungaro the spec did mention it, see https://github.com/conventional-commits/conventionalcommits.org/pull/185/files

The site is messed up to an old version now. Damn I got scared as my tool needs to adhere to the spec.

lppedd avatar Apr 11 '20 00:04 lppedd

@bcoe can you take a look about the last comment?

damianopetrungaro avatar Apr 11 '20 01:04 damianopetrungaro

I go with

feat(scope): QWE-123 my awesome cool feature title

iamandrewluca avatar Oct 04 '21 12:10 iamandrewluca

In the trailer.

<subject>

Fixes: id

LemmingAvalanche avatar Mar 20 '24 20:03 LemmingAvalanche