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

Migrate issue template to new format #15163

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

InSyncWithFoo
Copy link
Contributor

@InSyncWithFoo InSyncWithFoo commented Dec 27, 2024

Summary

Resolves #15135.

Test Plan


@MichaReiser
Copy link
Member

Thanks.

Does this mean that clicking New issue now always requires clicking on Bug report?

The old issue template intended something extremely lightweight. Our goal is to keep opening an issue as simple as possible without requiring any specific structure. While the new template looks okay, I think it's more structured than we want.

I think the best first step is to mimic what we had before: A single markdown field with a default text.

@MichaReiser MichaReiser added the internal An internal refactor or improvement label Dec 27, 2024
@InSyncWithFoo
Copy link
Contributor Author

InSyncWithFoo commented Dec 27, 2024

Does this mean that clicking New issue now always requires clicking on Bug report?

As far as I'm aware, yes (though one can also choose to click the "Open a blank issue" link at the bottom).

@MichaReiser
Copy link
Member

Hmm, yeah I think this is somewhat annoying and can be confusing. E.g., what are you supposed to do when you don't want to open a bug report? It might be confusing enough that people click away.

Considering all this, I'm leaning toward removing the template and we can explore something similar to uv's astral-sh/uv#9452 if we see details missing in many new issues

@InSyncWithFoo
Copy link
Contributor Author

InSyncWithFoo commented Dec 27, 2024

This PR does need a new "Feature request" template to go with "Bug report". I think these two will account for the vast majority of cases. People who are more involved with the project will know what to do with the blank template.

I'm leaning toward removing the template and we can explore something similar to uv [...]

That reminds me, uv also has a similarly outdated issue template. I'll submit a PR over there too once we decide what to do with this one.

@InSyncWithFoo
Copy link
Contributor Author

InSyncWithFoo commented Dec 27, 2024

(By the way, the new format allows automatic labeling, if that's something you might want to consider.)

@zanieb
Copy link
Member

zanieb commented Dec 27, 2024

I'm not sure if we want this. I've done a fair bit of investigation in the past. We'll need to talk about this once people are back from their holiday vacations.

@zanieb zanieb added the do-not-merge Do not merge this pull request label Dec 27, 2024
@MichaReiser
Copy link
Member

This PR does need a new "Feature request" template to go with "Bug report". I think these two will account for the vast majority of cases. People who are more involved with the project will know what to do with the blank template.

Yeah, but there are many more cases: changes to existing rules, questions, black deviations, style requests, etc.

My preferred solution remains just to remove the template, considering that we haven't been using the issue templates for a few weeks and that the issues opened during this time have been as good as before.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do-not-merge Do not merge this pull request internal An internal refactor or improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GitHub New Issue template appears empty / current template is deprecated
3 participants