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

docs: Add default template that diverts to sub templates #7306

Merged
merged 3 commits into from
May 30, 2024

Conversation

jbkyang-nvi
Copy link
Contributor

@jbkyang-nvi jbkyang-nvi commented May 30, 2024

What does the PR do?

This PR fixes this known github issue where multiple PR templates is not supported in Github.
It is an add on to PR 7290

Checklist

  • PR title reflects the change and is of format <commit_type>: <Title>
  • Changes are described in the pull request.
  • Related issues are referenced.
  • Populated github labels field
  • Added test plan and verified test passes.
  • Verified that the PR passes existing CI.
  • Verified copyright is correct on all changed files.
  • Added succinct git squash message before merging ref.
  • All template sections are filled out.
  • Optional: Additional screenshots for behavior/output changes with before/after.

Commit Type:

Check the conventional commit type
box here and add the label to the github PR.

  • build
  • ci
  • docs
  • feat
  • fix
  • perf
  • refactor
  • revert
  • style
  • test

Related PRs:

#7290

Where should the reviewer start?

.github/pull_request_template.md

Test plan:

I tested it with my own repository:
In the UI, if you create PR:
image
switching to Preview shows this:
image
You can click on one of the options:
image
to create the Pull Request.

If the PR requester skipped this step, they can populate the template themselves: https://raw.githubusercontent.com/triton-inference-server/server/main/.github/PULL_REQUEST_TEMPLATE/pull_request_template_external_contrib.md

Caveats:

This does not populate the correct template immediately, could cause confusion

Background

Multiple PR templates not supported in Github: https://stackoverflow.com/questions/73771068/multiple-templates-for-pull-requests-on-github/75030350#75030350
Alternatives are to use query parameters that are hard to use: https://github.blog/2018-01-25-multiple-issue-and-pull-request-templates/

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

  • closes GitHub issue: N/A

@jbkyang-nvi jbkyang-nvi added the PR: docs Documentation only changes label May 30, 2024
@jbkyang-nvi jbkyang-nvi requested review from nnshah1 and GuanLuo May 30, 2024 19:26
@jbkyang-nvi jbkyang-nvi merged commit 0df1fe7 into main May 30, 2024
3 checks passed
@jbkyang-nvi jbkyang-nvi deleted the kyang-update-pr-templates-with-default-template branch May 30, 2024 22:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: docs Documentation only changes
Development

Successfully merging this pull request may close these issues.

2 participants