Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Add issue reference to the PR template #36338

Closed
1 task done
chinmoy12c opened this issue Dec 1, 2020 · 2 comments
Closed
1 task done

doc: Add issue reference to the PR template #36338

chinmoy12c opened this issue Dec 1, 2020 · 2 comments
Labels
doc Issues and PRs related to the documentations.

Comments

@chinmoy12c
Copy link
Contributor

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.


  • I would like to work on this issue and
    submit a pull request.
@chinmoy12c chinmoy12c added the doc Issues and PRs related to the documentations. label Dec 1, 2020
@RaisinTen
Copy link
Contributor

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?

@chinmoy12c
Copy link
Contributor Author

chinmoy12c commented Dec 1, 2020

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.

chinmoy12c added a commit to chinmoy12c/node that referenced this issue Dec 8, 2020
The PR template should include a Reference isssue (Fixes #issue_number)
so 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.

Fixes: nodejs#36338
targos pushed a commit that referenced this issue Dec 21, 2020
The PR template should include a Reference isssue (Fixes #issue_number)
so 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.

Fixes: #36338

PR-URL: #36440
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this issue May 1, 2021
The PR template should include a Reference isssue (Fixes #issue_number)
so 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.

Fixes: #36338

PR-URL: #36440
Reviewed-By: James M Snell <jasnell@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants