ValveSoftware / Proton

Compatibility tool for Steam Play based on Wine and additional components
Other
24.13k stars 1.06k forks source link

Migrate from issue templates to issue forms #5054

Open HonkingGoose opened 3 years ago

HonkingGoose commented 3 years ago

Feature Request

I confirm:

Description

This is more of a repository maintenance thing.

GitHub has new Issue Forms. It's basically what it says on the tin: instead of a template, you now get a form.

The good thing with Forms is that you can now prevent people from proceeding until they have filled out all required fields (checkboxes/Proton version/Steam app id, and so on). You can add placeholder text so people have a example of the kind of data you're looking for.

~If you want, I can do the migration from issue templates -> issue forms for you.~

Justification [optional]

This will make it way easier for people to do the right thing the first time round. No more messing with confusing Markdown checkboxes, no more missed fields.

This should reduce the maintainers workload a little bit.

There are still ways to get around the forms unfortunately, so this is not 100% bullet proof, but still it should be a way better user experience.

Risks [optional]

It's a beta feature, so it might require some work to keep up to date.

References [optional]

GitHub documentation for new feature:

arrowgent commented 3 years ago

ive used this new github Forms feature and agree its much better design than a template

this Forms layout greatly improves users filling out data for the issues!

arrowgent commented 3 years ago

oh... the example previously mentioned

https://github.com/obsproject/obs-studio/issues/new?assignees=&labels=&template=bug_report.yaml

very fluid and useful for sorting out information

HonkingGoose commented 3 years ago

Hi @kisak-valve, I've created a repository with your new Issue Forms. πŸ˜‰

Click on the .yml files in the ISSUE_TEMPLATE directory to get a preview of the forms. [^throwaway ]

@kisak-valve and the Proton team are allowed to create issues on my repository to get a feel for the new Issue Forms. [^issues]

I haven't managed to find a way to add a h2 like ## Feature request or ## Compatibility Report to the top of the published form. Each item also get its own line, there's no way to group things like GPU, Drivers, Kernel, Gist and Proton together.

Please let me know what you think of the forms, and if you'd like a pull request from me to get them on the Proton repository. πŸ˜‰

[^throwaway]: Link to issue form files on my repo [^issues]: Link to Issue Select screen on my repo

HonkingGoose commented 4 months ago

@kisak-valve can you please tell me if you will accept a PR from to switch your issue templates to better issue forms? It's been a long time, and I never got any official response or feedback from the maintainers.

~I'm still willing to create the forms for you. But I do want official confirmation first. πŸ™‚~


Edit: I waited nearly three years and did not get any official response from this project about my proposal. :disappointed:

I'm done waiting for a go/no go. It seems this issue is very low on the list of priorities. I don't want to start working on something that may not get merged.

I still think a proper form makes it way easier for bug reporters to give the maintainers of Proton the correct information. So I still recommend you switch to proper forms.

I'll let you maintainers, or somebody else, work on the migration from Issue Templates to Issue forms.