Convert Issue templates to Forms #402
Conversation
|
@StephenBrown2 thanks so much for writing these! I had considered using them, but the main thing preventing me was that they don't yet properly work on GitHub's app. They work in mobile browsers though, so I'm definitely up for merging this! One thing that would be nice to have though: automatically attach the label to the Form, similar to what I did here: https://github.com/tycrek/ass/blame/master/.github/ISSUE_TEMPLATE/feature-request.yml#L4 Regarding Other... I think option 2 is a good way to go about this:
Though I don't have much experience with Discussions yet. What would you suggest? |
I did make sure to keep the labels you already had, but they don't show up in my screenshots because I didn't have those labels created before making the issues:
If you go with Option 2, you'll need to enable the Discussions feature on the repo, and I would suggest maybe converting all the existing "other" tagged issues to discussions so that folks can find them once being directed there (Option 1a). I'm not sure why the auto-converting said it wouldn't work for future issues (Option 1b) when I tried in my fork, but it won't matter too much if you move to discussions for non-CRUD Issues (Option 2). I've had a bit of experience with discussions in the python-httpx repository, and GitHub gives you several categories to choose from off the bat, so I think it's a useful addition and better alternative to tagging open-ended issues with 'other'. I'll go ahead and remove the Other template and re-enable the link to discussions. |
|
Thanks again @StephenBrown2 ! |
Details
I recently noticed in another repo that GitHub has the ability to use forms for its issue templates now, and I thought it might significantly help in the quality of submitted issues to this repository and reduce frustration on both contributor and maintainer's sides.
New Alternative
Here is the new "New Alternative" view (some fields have been made required, and the CONTIBUTING/CONTRIBUTORS.md files are links again, I fixed that after taking the screenshot):
and the resulting issue after partially filling out the template:
Fix Alternative
Here is the new look for "Fix Alternative":
Remove Alternative
Here is the "Remove Alternative":
Other
Here I am of two minds. Historically "Other" has been handled by issues with the
otherlabel, and so the new view does the same:However, GitHub does have "Discussions", which can either be converted from Issues (and even in bulk/automatically from a particular label), or you can direct users to start a discussion straight from the Issue template chooser, so I've added that as an option as well:
I only expect one of three options to be taken:
otherlabel are converted to Discussions, and done so automatically upon creationothertagged issuesThe benefit of keeping the issues tagged with other is that you can still take advantage of the form and require some structure (and checking the box that the user has read the contribution guidelines) before starting a discussion. In testing it told me it would not automatically convert issues with that label in the future, so perhaps you should stick with option #2 or #3.
I've reverted the discussion pointer in 0a0a6e1 so this can be merged as is. If you would like to enable discussions the first two options can be decided on.
Obviously very open to feedback on this unsolicited change suggestion, I only hope it's helpful!