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: remove "Related Issues" from pull request template #36590

Closed
wants to merge 2 commits into from

Conversation

Trott
Copy link
Member

@Trott Trott commented Dec 21, 2020

We don't require an issue for a pull request. This section
ends up displaying confusing default content.

Related Issues

Fixes: https://github.com/nodejs/node/issues/<issue_number>

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added the meta Issues and PRs related to the general management of the project. label Dec 21, 2020
Copy link
Member

@richardlau richardlau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The template is replicated in doc/guides/contributing/pull-requests.md (this seems like a maintenance annoyance to me if we have to keep them in step. See https://github.com/nodejs/node/pull/36440/files (the PR that added the section being removed).

@Trott
Copy link
Member Author

Trott commented Dec 21, 2020

The template is replicated in doc/guides/contributing/pull-requests.md (this seems like a maintenance annoyance to me if we have to keep them in step. See https://github.com/nodejs/node/pull/36440/files (the PR that added the section being removed).

This pull request now eliminates that maintenance annoyance by linking to the raw GitHub template.

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Trott
Copy link
Member Author

Trott commented Dec 22, 2020

This section ends up displaying confusing default content.

If anyone needs more reasons to LGTM this: I just noticed that when the section isn't filled in, it ends up causing node-core-utils to insert broken metadata into commit messages. This is flagged by core-validate-commit so the lander gets to fix it first, but that's an annoyance and it also breaks the automated commit queue.

We don't require an issue for a pull request, so this section usually
ends up displaying confusing default content.

PR-URL: nodejs#36590
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
The pull-request template was replicated in the pull-requests.md which
is a maintenance annoyance when changing the template. Replace the
replication with a link to the raw template.

PR-URL: nodejs#36590
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
@Trott
Copy link
Member Author

Trott commented Dec 23, 2020

Landed in e22b751...2c8751c

@Trott Trott closed this Dec 23, 2020
@Trott Trott deleted the hide-it branch December 23, 2020 13:49
danielleadams pushed a commit that referenced this pull request Jan 12, 2021
We don't require an issue for a pull request, so this section usually
ends up displaying confusing default content.

PR-URL: #36590
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
danielleadams pushed a commit that referenced this pull request Jan 12, 2021
The pull-request template was replicated in the pull-requests.md which
is a maintenance annoyance when changing the template. Replace the
replication with a link to the raw template.

PR-URL: #36590
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
@danielleadams danielleadams mentioned this pull request Jan 12, 2021
targos pushed a commit that referenced this pull request May 1, 2021
We don't require an issue for a pull request, so this section usually
ends up displaying confusing default content.

PR-URL: #36590
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
targos pushed a commit that referenced this pull request May 1, 2021
The pull-request template was replicated in the pull-requests.md which
is a maintenance annoyance when changing the template. Replace the
replication with a link to the raw template.

PR-URL: #36590
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
@danielleadams danielleadams mentioned this pull request May 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Issues and PRs related to the general management of the project.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants