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

New Issue

GiteaMirror · 2026-02-17T11:44:36-06:00

GiteaMirror commented

2026-02-17 11:44:36 -06:00

Originally created by @dagadbm on GitHub (Feb 21, 2020).

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?

Originally created by @dagadbm on GitHub (Feb 21, 2020). 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?

GiteaMirror commented

2026-02-17 11:44:38 -06:00

@damianopetrungaro commented on GitHub (Feb 21, 2020):

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 commented on GitHub (Feb 21, 2020): 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) ```

GiteaMirror commented

2026-02-17 11:44:39 -06:00

@lppedd commented on GitHub (Apr 10, 2020):

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

@lppedd commented on GitHub (Apr 10, 2020): @damianopetrungaro the problem is you're not following the specification for the footer, which requires a `: ` separator

GiteaMirror commented

2026-02-17 11:44:40 -06:00

@damianopetrungaro commented on GitHub (Apr 10, 2020):

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

@damianopetrungaro commented on GitHub (Apr 10, 2020): @lppedd where is it mentioned in the spec? It isn't specified as far as I can see

GiteaMirror commented

2026-02-17 11:44:41 -06:00

@lppedd commented on GitHub (Apr 11, 2020):

@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 commented on GitHub (Apr 11, 2020): @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?

GiteaMirror commented

2026-02-17 11:44:43 -06:00

@lppedd commented on GitHub (Apr 11, 2020):

@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 commented on GitHub (Apr 11, 2020): @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.

GiteaMirror commented

2026-02-17 11:44:44 -06:00

@damianopetrungaro commented on GitHub (Apr 11, 2020):

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

@damianopetrungaro commented on GitHub (Apr 11, 2020): @bcoe can you take a look about the last comment?

GiteaMirror commented

2026-02-17 11:44:45 -06:00

@unrevised6419 commented on GitHub (Oct 4, 2021):

I go with

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

@unrevised6419 commented on GitHub (Oct 4, 2021): I go with ``` feat(scope): QWE-123 my awesome cool feature title ```

GiteaMirror commented

2026-02-17 11:44:46 -06:00

@LemmingAvalanche commented on GitHub (Mar 20, 2024):

In the trailer.

<subject>

Fixes: id

@LemmingAvalanche commented on GitHub (Mar 20, 2024): In the trailer. ``` <subject> Fixes: id ```

GiteaMirror commented

2026-02-17 11:44:47 -06:00

@torsknod2 commented on GitHub (Feb 22, 2025):

Two cases should be distinguished:

There are projects with strict change management and tracking requirements, which require exactly on issue to be referenced from a commit and projects which allow multiple issues to be referenced.
For projects where only one issue is referenced, this should be in the first line.

For projects where multiple issues are referenced, there should be three ways:

A pure reference, e.g. in the footer
A reference with additional explanation specific to the issue
An explanation referencing zero/ one or more issues

Further it should be possible to distinguish:

Mentioning issues, because they are somehow related
Supporting issues by helping to get them resolved
Actually (finally) closing/ resolving an issue

Regarding references to the issues:

Some people might want to have the issue summary in the shown text, others not
Some systems have deep-URIs to their issues, others just have some kind of keys. Further some of them having keys require them to have a prefix, e.g. #.

@torsknod2 commented on GitHub (Feb 22, 2025): Two cases should be distinguished: - There are projects with strict change management and tracking requirements, which require exactly on issue to be referenced from a commit and projects which allow multiple issues to be referenced. - For projects where only one issue is referenced, this should be in the first line. For projects where multiple issues are referenced, there should be three ways: - A pure reference, e.g. in the footer - A reference with additional explanation specific to the issue - An explanation referencing zero/ one or more issues Further it should be possible to distinguish: - Mentioning issues, because they are somehow related - Supporting issues by helping to get them resolved - Actually (finally) closing/ resolving an issue Regarding references to the issues: - Some people might want to have the issue summary in the shown text, others not - Some systems have deep-URIs to their issues, others just have some kind of keys. Further some of them having keys require them to have a prefix, e.g. `#`.

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/conventionalcommits.org#89