ValveSoftware / ValveSoftware/Proton
Migrate from issue templates to issue forms
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 32.8k
- Forks
- 1.6k
- PR merge metrics
- PR metrics pending
Description
Feature Request
I confirm:
- that I haven't found another request for this feature.
- that I have checked whether there are updates for my system available that
contain this feature already.
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:
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the repository's existing issue templates and the linked GitHub documentation on issue forms and form schema. Migrate the templates to forms with required fields and useful placeholders; done means the repository offers the intended forms and no longer relies on the old templates.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100