-
Notifications
You must be signed in to change notification settings - Fork 0
[feature:] add Issue number to PR template #7
Description
Describe the situation that led to the request and a solution
In NOAA-FIMS/FIMS we are going to use a GitHub action to change a label from "status: in progress" to "status: in dev" when a PR is merged into dev because Issues are not actually closed until they are in main but we need a way to know that they do not need to be worked on any more. This requires that PRs have linked Issues to know which Issues should have changes in status. Therefore, the PR template needs to have a section where users are TOLD to input the Issue numbers that are relevant.
Alternative solutions
Just rely on GitHub users to know the convention that they should link the PR to an issue but this is not an easy thing to remember 🤦♀️!
Statistical validity
No response
Additional context
Here is the original idea from @Bai-Li-NOAA in NOAA-FIMS/FIMS
No worries, @kellijohnson-NOAA. I think the simplest way to link an issue with a PR is to add a section (as the first question) in the PR template that asks: “Is this PR linked to an existing issue? If so, provide the issue number (#number); if not, enter NA.”
This way, we can parse the first response to extract the issue number. We could also encourage reviewers to remind PR submitters to complete the template.
Originally posted by @Bai-Li-NOAA in #939
Additionally, I have upvoted the need for PR Templates/Forms rather than just Issue Forms in the GitHub user community. Hopefully GitHub will get to creating this functionality because we could sure use it.