[github] Switch from the old Jira format to github issues for the PR template #60896
Conversation
|
@shahmishal, please merge if okay. |
| <!-- If this pull request resolves any bugs in the Swift bug tracker, provide a link: --> | ||
| Resolves SR-NNNN. | ||
| <!-- If this pull request resolves any GitHub issues, mention them: --> | ||
| Resolves #NNNNN, fix apple/llvm-project#MMMMM. |
There was a problem hiding this comment.
| Resolves #NNNNN, fix apple/llvm-project#MMMMM. | |
| Resolves #NNNNN. |
What is the main reason for including fix apple/llvm-project#MMMMM.
There was a problem hiding this comment.
I specifically used llvm-project as an example of closing an issue on an external repo, whereas you are only showing closing issues on this repo, as mentioned in the resolved conversation above.
There was a problem hiding this comment.
This can be confusing, are you ok with dropping the external repo?
There was a problem hiding this comment.
If we decide not to mention an external repo, which IMO is a legit case, since the Swift project is an umbrella, and issues in other repositories such as the package manager may turn out to be compiler issues, let us at least show how to link multiple issues to a PR. This was my original motivation for the comma-separated list.
There was a problem hiding this comment.
I think it's worth keeping and only added the second issue on Anthony's suggestion, but can remove it if you think it's not worth it.
There was a problem hiding this comment.
GitHub will not pick this up, you need to repeat one of the supported keywords for every issue you want to link. This is the reason I suggested adding a second issue to the clause — writing "Resolves #X, #Y" rather than "Resolves #X, resolves #Y" is a common and unexpected slip.
There was a problem hiding this comment.
FYI I’m OK with using a mock repo for the second issue as in Mishal’s example.
There was a problem hiding this comment.
I think it's better to show an example of the most likely external repo that this compiler repo will link to, but can make it generic if you guys want.
There was a problem hiding this comment.
@shahmishal, is this pull okay now? Please approve or let me know if any more tweaks are needed.
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| @@ -1,8 +1,8 @@ | |||
| <!-- What's in this pull request? --> | |||
| Replace this paragraph with a description of your changes and rationale. Provide links to external references/discussions if appropriate. | |||
|
|
|||
| <!-- If this pull request resolves any bugs in the Swift bug tracker, provide a link: --> | |||
| Resolves SR-NNNN. | |||
| <!-- If this pull request resolves any GitHub issues, mention them: --> | |||
There was a problem hiding this comment.
| <!-- If this pull request resolves any GitHub issues, mention them: --> | |
| <!-- | |
| If this pull request resolves any GitHub issues, link them. | |
| For more information about linking a pull request to an issue, see: | |
| https://docs.github.com/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue | |
| --> |
There was a problem hiding this comment.
Added this link and kept the two issues as an example, let me know if this is okay.
@AnthonyLatsis, please review.