[go: up one dir, main page]

Skip to content

Link to / Reference an issue comment in a commit message

Release notes

Problem to solve

Issues can often get lengthy when there are multiple contributors. One commit might fix something discussed in a single comment on the issue tracker, and it would be nice to track specifically what it references.

Intended users

Developers / anyone making commits based on issues

User experience goal

A commit should be able to link to an issue, or a specific part of an issue such as a comment. The user should be able to put some sort of information in the commit message to link that commit to a specific comment on an issue.

Proposal

Allow a commit message like like Fix discussed in #123@456 to reference issue 123's comment 456, showing the commit hash under this comment.

Further details

Something like this would be useful for when a specific comment contains information relevant to the commit - perhaps a screenshot, a list of options to help resolve the issue, a bug that is part of the issue's implementation, etc. Adding this feature would allow such comments to be addressed more specifically than the #12 link to the whole issue.

Permissions and Security

Permission to commit is all that is needed.

Documentation

Availability & Testing

What does success look like, and how can we measure that?

What is the type of buyer?

Is this a cross-stage feature?

Links / references