Skip to content

[github] Switch from the old Jira format to github issues for the PR template #60896

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 23, 2022
Merged

[github] Switch from the old Jira format to github issues for the PR template #60896

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
<!-- 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, link them.
For 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
-->
Resolves #NNNNN, fix apple/llvm-project#MMMMM.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Resolves #NNNNN, fix apple/llvm-project#MMMMM.
Resolves #NNNNN.

What is the main reason for including fix apple/llvm-project#MMMMM.

Copy link
Member Author

Choose a reason for hiding this comment

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

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.

Copy link
Member

Choose a reason for hiding this comment

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

This can be confusing, are you ok with dropping the external repo?

Copy link
Collaborator

@AnthonyLatsis AnthonyLatsis Sep 7, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

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.

Copy link
Collaborator

@AnthonyLatsis AnthonyLatsis Sep 20, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

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.

Copy link
Member

Choose a reason for hiding this comment

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

That's good point.

Copy link
Collaborator

Choose a reason for hiding this comment

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

FYI I’m OK with using a mock repo for the second issue as in Mishal’s example.

Copy link
Member Author

Choose a reason for hiding this comment

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

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

@shahmishal, is this pull okay now? Please approve or let me know if any more tweaks are needed.


<!--
Before merging this pull request, you must run the Swift continuous integration tests.
Expand Down