Navigation Menu

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

Closed
josharian opened this issue Jan 19, 2019 · 10 comments
Closed

.github: use multiple issue templates? #29839

josharian opened this issue Jan 19, 2019 · 10 comments
Labels
Community FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Milestone

Comments

@josharian
Copy link
Contributor

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 NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. Community labels Jan 21, 2019
@dmitshur dmitshur added this to the Unreleased milestone Jan 21, 2019
@dmitshur
Copy link
Contributor

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
Copy link
Contributor Author

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
Copy link
Contributor

dmitshur 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.

@seankhliao
Copy link
Member

I think this would be more useful now that we also have separate instructions for gopls, pkgsite, and language changes

With an extra .github/ISSUE_TEMPLATE/config.yml, we can also control blank issues and add links for questions/security

ref:

@dmitshur
Copy link
Contributor

dmitshur commented Nov 15, 2021

I think there's a good chance it is worth doing now.

To make progress here, I suggest creating a test repo and experiment there. Once we have something that seems like a net positive change, we can adopt it in the main Go issue tracker. Having that test repository to see how it actually works and looks will make it easier to evaluate that step.

@seankhliao
Copy link
Member

I've created a quick demo with the templates I know about, though a lot of the naming/wording would need work
https://github.com/seankhliao/testrepo-666/issues/new/choose

@josharian
Copy link
Contributor Author

There are lots of little tweaks that I would make, but that looks really promising, @seankhliao. Thanks for putting it together! Let's do it.

@toothrot toothrot added this to Planned in Go Release Team Nov 23, 2021
@toothrot toothrot moved this from Planned to In Progress in Go Release Team Nov 23, 2021
@gopherbot
Copy link

Change https://golang.org/cl/366736 mentions this issue: .github: use multiple issue templates

@dmitshur dmitshur added NeedsFix The path to resolution is known, but the work has not been done. and removed NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. labels Nov 23, 2021
@dmitshur
Copy link
Contributor

dmitshur commented Dec 3, 2021

I've made CL 369154 that adds special handling of existing go.dev/issue/new links for if we need it.

Go Release Team automation moved this from In Progress to Done Dec 3, 2021
@gopherbot
Copy link

Change https://golang.org/cl/369154 mentions this issue: internal/redirect: add special case for /issues/new for multiple templates

gopherbot pushed a commit to golang/website that referenced this issue Dec 6, 2021
…lates

For golang/go#29839.

Change-Id: Ic6ff96d0d1321946df7f19a9f4af889e90255cb1
Reviewed-on: https://go-review.googlesource.com/c/website/+/369154
Trust: Dmitri Shuralyov <dmitshur@golang.org>
Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Jamal Carvalho <jamal@golang.org>
passionSeven added a commit to passionSeven/website that referenced this issue Oct 18, 2022
…lates

For golang/go#29839.

Change-Id: Ic6ff96d0d1321946df7f19a9f4af889e90255cb1
Reviewed-on: https://go-review.googlesource.com/c/website/+/369154
Trust: Dmitri Shuralyov <dmitshur@golang.org>
Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Jamal Carvalho <jamal@golang.org>
@golang golang locked and limited conversation to collaborators Jun 23, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Community FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
Archived in project
Development

No branches or pull requests

7 participants