Skip to content

Conversation

Kyle-Ye
Copy link
Contributor

@Kyle-Ye Kyle-Ye commented Jun 14, 2022

Bug/issue #, if applicable:

Summary

After #300 was merged, we lose the ability to use a default PR template when creating PR directly in Github website.

See more discussion here. https://github.community/t/is-there-a-pull-request-template-selector-similar-to-issues

Dependencies

None

Testing

None

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

  • Added tests
  • Ran the ./bin/test script and it succeeded
  • Updated documentation if necessary

@franklinsch
Copy link
Contributor

Given this, I'd prefer us combining the two templates into one so that they're more visible. See #300 (comment)

@Kyle-Ye
Copy link
Contributor Author

Kyle-Ye commented Jun 14, 2022

templates

What if we have more than 2 templates? I think we should follow the Github spec instead of putting them in one file. See all the reasons I list on #300. Given that we lose discoverability of the cherry-pick template, we can add some comment in the header in default template.

If you're opening a PR to cherry-pick a change for a release branch, use this template instead:
https://github.com/apple/swift-docc/blob/main/.github/PULL_REQUEST_TEMPLATE/CHERRY_PICK.md

Curretnly, Github website does not have a UX for it.
You can manually set the template on qurey parmas eg. https://github.com/apple/swift->docc/compare/release/5.7...apple:main?template=CHERRY_PICK.md
or use GitHub CLI - gh to choose all the PR templates.

@Kyle-Ye Kyle-Ye force-pushed the default_pr_template branch from a6bd559 to 77ab519 Compare June 14, 2022 14:54
@Kyle-Ye Kyle-Ye force-pushed the default_pr_template branch from 77ab519 to 60bcc8c Compare June 14, 2022 14:56
Copy link
Contributor

@franklinsch franklinsch left a comment

Choose a reason for hiding this comment

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

Thanks for working through this @Kyle-Ye, I really appreciate it 🙏

@Kyle-Ye
Copy link
Contributor Author

Kyle-Ye commented Jun 14, 2022

@swift-ci please test

@Kyle-Ye Kyle-Ye merged commit cd15ec3 into swiftlang:main Jun 14, 2022
@Kyle-Ye Kyle-Ye deleted the default_pr_template branch June 14, 2022 15:24
@Kyle-Ye
Copy link
Contributor Author

Kyle-Ye commented Jun 14, 2022

The default PR template is back now.

By the way, can we make some progress on #268?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants