Hacker News Reader

Comment by k_ | Hacker News Reader

I'd say _add_ issue tracker reference, not replace the description with it

    43ec6aa Fix error when the URL is not reachable (#1001)
    4fe84ab Add error message if something went wrong (#1002)
    753aa05 Add server fingerprint check (#1003)
    df3a662 Fix shadow box closing problem (#1004)

View on HN

this.

Issue trackers like JIRA can be configured to search for commit-Ids in the messages, which will give you all commits associated with a ticket.

Adding ticket IDs to commits has fallen a bit out of fashion since feature-branches and pull request workflows have become popular. But adding the ticket ID to the commit messages allows for trunk-based development style, while not losing the ability to make a code review over the commits referencing a ticket.

Most of the time I write the ticket ID in the text below, which keeps the `git log --oneline` pretty, the tools can still pick it up.

Yup, though I usually put the ticket number in the body of the commit rather than the title.

I tend to put it in at the front:

    43ec6aa [1001] Fix error when the URL is not reachable
    4fe84ab [1002] Add error message if something went wrong
    753aa05 [1003] Add server fingerprint check 
    df3a662 [1004] Fix shadow box closing problem

That makes the corresponding issue easier to find.

Me too, but I put a full hyperlink to the github/gitlab issue in the body instead of just the number so that someone can just click and start reading what it's about. It also creates a back-reference on the issue page in some web-based issue trackers like Github.

Reply on news.ycombinator.com