Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Shall the issue number be mentioned in commit title?

See original GitHub issue

In #229 IDE specific configuration files / support for specific IDE features are discussed. One of them are clickable issue/PR links inside IDEAs git history. As long as there is no build-in functionality for that provided by IDEA itself, we decided to provide an intermediate solution (see discussion in #229 and PR in #262).

To make use of this feature, we would have to decide to mention the issue and or PR number inside the header line of commits, so they show up in history. This was done sometimes in Pioneer history, but in the later time it was not done by purpose.

@nicolaiparlog Can you write down why? I remember that you phrases this out some months ago on stream, but I can’t remember the cause - I think it was something about less space for title message due the needed characters for the issue

Regardless of the outcome of this discussion it should be placed inside the CONTRIBUTING.md file. There is already a section in it about writing the “final” commit, but there are not information about the title of those commits.

Issue Analytics

State:
Created 3 years ago
Comments:5 (5 by maintainers)

Top GitHub Comments

3reactions

aepflicommented, May 25, 2020

although it seems to be useful, the interesting part to mention is, that the issue link navigation not only applies to the header, but everywhere the git commit message is parsed:

in the git log
in the annotate

and so on. So the git commit title is definitely useful, and makes it easier to navigate.

0reactions

Bukamacommented, Jun 18, 2020

#273 was merged, so closing this issue

Top Results From Across the Web

Link to the issue number on GitHub within a commit message

In order to link the issue number to your commit message, you should add: #issue_number in your git commit message. Example Commit Message...

Link to the issue number on GitHub within a commit message

Hi Guys, Is there any way to automatically have a link to the GitHub issue number in the git commit message?

How to write a Git commit message properly with examples

Think of your subject line in comparison to newspaper headlines. Neither a git subject line nor a newspaper headline should end with a...

Automatically prefix JIRA issue numbers to Git commit messages

Naming your git branches. For this technique to work, you need to make sure that you include the issue number in the name...

Commit message guidelines - gists · GitHub

Commit Message Guidelines. Short (72 chars or less) summary More detailed explanatory text. Wrap it to 72 characters. The blank line separating the...