mpv icon indicating copy to clipboard operation
mpv copied to clipboard

github/issue_template: rework issue templates with github forms

Open Akemi opened this issue 1 year ago • 5 comments

i would like to revisit the github forms for issue templates. we previously had a short discussion (#9938) which didn't lead to anything, and i still think the current issue templates are a bit lacking and confusing. even if we just settle with the minimum version, separating instruction from the issue template (description text above the text field), it would be a huge improvement over the current state.

this PR is a full blown suggestion of what could be done. it can be seen in action on my fork: https://github.com/Akemi/mpv/issues/new/choose and https://github.com/Akemi/mpv/issues

admittedly the changes here are quite extensive and might be a bit much, though i am open to simplify them if needed. though my general wish and goal is:

  • instructions separated from the actual issue template
  • prevent issues with infos and not removed issue template instruction entangled
  • just plain unfilled issue template issues
  • structured and consistent filled out issues

also see my comment, for my reasoning and additional suggestions.

since the question template was removed (https://github.com/mpv-player/mpv/commit/2babe02f0f58711d19f3cd412fe84a41bf3946fd), i added a short mention of the new Discussions on the issue template choose page with a link.

docs: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms

Fixes #11515

Akemi avatar Apr 20 '24 23:04 Akemi

updated the templates a bit with the suggestions.

Akemi avatar Apr 24 '24 19:04 Akemi

i think i addressed everything for now. so how do we want to go forward with this? i personally think this is a huge improvement over the status quo. though i don't want to force my opinion on the rest of the active maintainers.

Akemi avatar May 09 '24 13:05 Akemi

i addressed the additions of the recent review now.

Akemi avatar May 11 '24 13:05 Akemi

LGTM too, thanks.

kasper93 avatar May 11 '24 20:05 kasper93

thanks for all the feedback.

Akemi avatar May 17 '24 18:05 Akemi