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

.github: use multiple issue templates? #29839

Open
josharian opened this issue Jan 19, 2019 · 3 comments

Comments

@josharian
Copy link
Contributor

commented Jan 19, 2019

GitHub now supports having multiple issue templates: https://github.blog/2018-01-25-multiple-issue-and-pull-request-templates/

We could use this e.g. to have different templates for proposals vs regular issues. On the other hand, it adds another click between golang.org/issue/new and actually typing text. (We have also long discussed a bug filing wizard (bug.golang.org), but that seems to be forgotten/abandoned.)

Thoughts? @dmitshur

@dmitshur dmitshur added this to the Unreleased milestone Jan 21, 2019

@dmitshur

This comment has been minimized.

Copy link
Member

commented Jan 21, 2019

We could use this e.g. to have different templates for proposals vs regular issues.

Adding a .github/ISSUE_TEMPLATE/proposal.md sounds reasonable to me.

On the other hand, it adds another click between golang.org/issue/new and actually typing text.

I don't understand why that would be, can you elaborate? As I understand, golang.org/issue/new would continue to redirect to https://github.com/golang/go/issues/new, which would continue to use the default .github/ISSUE_TEMPLATE.md template (we'd have to give the existing file an .md extension to not collide with the new directory). From the GitHub blog post:

Your default ISSUE_TEMPLATE.md files will continue to work as the default when a template isn’t specified in the new issue URL.

To get to the proposal template, one would have to visit https://github.com/golang/go/issues/new?template=proposal.md. We could consider making a shortlink on golang.org for it, for example golang.org/issue/new?template=proposal.md or golang.org/issue/new/proposal.

The go bug command is relevant here, but I don't think it needs to support making proposals.

@josharian

This comment has been minimized.

Copy link
Contributor Author

commented Jan 21, 2019

I don't understand why that would be, can you elaborate?

I was wrong. However, it does add an extra step when you are at the GitHub issue page and then click "New issue". To experience it yourself, go e.g. to https://github.com/tensorflow/tensorflow/issues and click "New issue". (And if we wanted that, looks like we could have golang.org/issues/new link to github.com/golang/go/issues/new/choose).

@dmitshur

This comment has been minimized.

Copy link
Member

commented Jan 21, 2019

However, it does add an extra step when you are at the GitHub issue page and then click "New issue". To experience it yourself, go e.g. to https://github.com/tensorflow/tensorflow/issues and click "New issue".

This is true.

I originally suspected it's because they don't have a default issue template. See the .github directory. If there was a .github/ISSUE_TEMPLATE.md default template there, I thought it'd be used by default.

However, that's not the case. It can be seen by clicking "New issue" at https://github.com/gogs/gogs/issues, despite their .github directory having both a default ISSUE_TEMPLATE.md and two templates in .github/ISSUE_TEMPLATE directory, it still takes you to an issue template choice interstitial at https://github.com/gogs/gogs/issues/new/choose.

And if we wanted that, looks like we could have golang.org/issues/new link to github.com/golang/go/issues/new/choose.

Yep. We have control over whether to skip the interstitial by choosing to redirect either to /issues/new or /issues/new/choose.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.