Add issue templates

[zanieb]

Follows #15651

Preview: https://github.com/dhruvmanila/ruff-issue-templates/issues

GitHub made the interface for single-template repositories worse. While they might fix it, it encouragement to just do this work. They still haven't fixed the teeny tiny emojis which makes me think this won't be fixed quickly.

Before:

After:

[MichaReiser]

Hmm, not sure. I'd rather just go back to delete the issue template again or we dedicate time to design issue templates for ruff:

• new rule
• bug (should mention the rule, if applicable)

but that may require some more thought and I'm not sure it's worth it.

[MichaReiser]

I reported the issue on their feedback discussion https://github.com/orgs/community/discussions/148713#discussioncomment-12225604

[zanieb]

I'm not sure I agree it's really an either or here? Adding the initial templates is still a step forward. Adding a "new rule" template is another step forward.

[dhruvmanila]

I agree with Micha that this might require some more thought but I'd be ok with including "Bug report", "Feature request", and a "Blank issue".

For Ruff, there are two places where users can ask questions - discussions or issue tracker. We haven't provided any strong recommendation on where to ask questions and we leave it to the user wherever they feel comfortable. For this reason, I'm not sure if we should include a "Question" template.

It might be useful to have a single place where we collect all these questions. I very much prefer discussions for user queries because of separate threads.

So, we could possibly replace the "Question" template with redirecting the users to the discussion or include the following two links in the "Question" template:

• Discussion - https://github.com/astral-sh/ruff/discussions
• Searching resolved questions: https://github.com/astral-sh/ruff/issues?q=is:issue%20state:closed%20label:question

[zanieb]

For Ruff, there are two places where users can ask questions - discussions or issue tracker. We haven't provided any strong recommendation on where to ask questions and we leave it to the user wherever they feel comfortable. For this reason, I'm not sure if we should include a "Question" template.

This is a great point. We can link to the Discussions page instead.

[MichaReiser]

Hmm. I'm sort of leaning towards not having to think about this right now ;)

I'm not sure if I agree with promoting discussions for questions because questions sometimes turn out to be bugs that then need to be transferred. I also don't track discussions as closely as I do issues.

[MichaReiser]

Github's now aware of the bug https://github.com/orgs/community/discussions/148713#discussioncomment-12226081

[zanieb]

I think we should just bias towards action here because this is very low-cost to iterate on and the current UX is clearly worse.

[dhruvmanila]

I'm not sure if I agree with promoting discussions for questions because questions sometimes turn out to be bugs that then need to be transferred. I also don't track discussions as closely as I do issues.

I don't think transferring should be much of an issue as GitHub provides a one-click solution to this. My main motivation for keeping questions in a single place is for visibility and provide an easy way to search through existing resolved queries. This is not to say to transfer all existing issues but just to divert users to use a single place to store all queries.

[zanieb]

I'm going to hand this over to @dhruvmanila — I don't think I can advocate for any particular solution over here.

[MichaReiser]

I'm still undecided on this. I think what we have now works well and I see little reason for changing it. But I also don't want to stay in the way but:

• Let's add a Blank issue entry. There are many more reasons other than questions, bug reports, and new rules (e.g. formatter style, rule changes, rule removals, etc)
• I'd prefer to keep adding labels manually. There are often bug reports that are none. I also use the labels to know if someone from the team looked at the issue. We'd lose that bit of information by auto labelling issues.

[dhruvmanila]

• Let's add a Blank issue entry. There are many more reasons other than questions, bug reports, and new rules (e.g. formatter style, rule changes, rule removals, etc)

Are you suggesting an explicit entry because it is automatically created (refer to the screenshot in the PR description)?

• I'd prefer to keep adding labels manually. There are often bug reports that are none. I also use the labels to know if someone from the team looked at the issue. We'd lose that bit of information by auto labelling issues.

That seems reasonable, I'll remove it. A potential solution would be to add a "needs-triage" label explicitly but we could leave that for future as we decided (in the past) to not move forward with it.

This does mean that the main benefit of using issue templates would be to provide suggestions based on what the user is intending to open an issue about. For example, if it's a bug report, we're asking them to check existing issues and optionally include the playground link for better reproduction.

[dhruvmanila]

Preview link to try out: https://github.com/dhruvmanila/ruff-issue-templates/issues

[MichaReiser]

Are you suggesting an explicit entry because it is automatically created (refer to the screenshot in the PR description)?

Sorry, I didn't realize it was there. There are so many options!

For example, if it's a bug report, we're asking them to check existing issues and optionally include the playground link for better reproduction.

Yeah, that's fair. At least if we use the same fields. We could consider explicitly asking for the rule code for bug reports.

[dhruvmanila]

Yeah, that's fair. At least if we use the same fields. We could consider explicitly asking for the rule code for bug reports.

Yeah, we could add multiple fields based on what's the most useful information that's required but I think it's best to iterate on it in follow-ups.