Repository navigation
doc: Add issue reference to the PR template #36338
Description
Activity
Hey. :)
Step 4 of the commit message guidelines already states that if the patch fixes an issue, it can be referenced at the end of the commit message body using the full URL. When a PR is opened, the commit message body of the first commit is automatically prepended to the PR template. Adding a field for the referenced issue in the PR template would require a manual removal of it because the PR body already contains the link to the referenced issue.
So, do you still think it is necessary?
Hey. :)
Step 4 of the commit message guidelines already states that if the patch fixes an issue, it can be referenced at the end of the commit message body using the full URL. When a PR is opened, the commit message body of the first commit is automatically prepended to the PR template. Adding a field for the referenced issue in the PR template would require a manual removal of it because the PR body already contains the link to the referenced issue.
So, do you still think it is necessary?
Hi :),
yes @RaisinTen you are right about the commit guidelines. Although, it's not a strict guideline as it says -
"If your patch fixes an open issue, you can add a reference to it at the end of the log.",
and I see that many PRs are without this tailing link of the issue in the commit message. Also, manually going to through the commits to find the issue (for example, when there are multiple commits) seems rather unnecessarily cumbersome than just getting the linked issue from the PR template itself.Maybe input from other people as well would be helpful in this.
- added a commit that references this issue
on Dec 21, 2020 - added a commit that references this issue
on May 1, 2021 - added a commit that references this issue
on May 22, 2026
Affected URL(s):
Description
✍️
The PR template should include a
Reference isssue (Fixes #issue_number)so the the PR can be tracked back to the issue easily. For a beginner trying to read PRs to become comfortable with the codebase, it is really helpful if one can directly reach the issue the PR fixes.submit a pull request.