search

OrchardCMS / OrchardCore

Orchard Core is an open-source modular and multi-tenant application framework built with ASP.NET Core, and a content management system (CMS) built on top of that framework.
https://orchardcore.net
BSD 3-Clause "New" or "Revised" License
7.46k stars 2.41k forks source link

Use fancy issue templates #11038

Open Piedone opened 2 years ago

Piedone commented 2 years ago

Is your feature request related to a problem? Please describe.

Issue templates are great as a guidelines but they are a bit cumbersome to fill out, all in Markdown.

Describe the solution you'd like

There is a fancier way to configure such issue templates, see e.g. these ones: https://github.com/NuGet/NuGetGallery/issues/new/choose You don't just get a textbox with some structure, but an actual custom form: image

Describe alternatives you've considered

Just leaving as it is, but these forms are pretty cool. As someone who created two issues there, the experience was much better than with text templates.

deanmarcussen commented 2 years ago

Cool. When it is done, can we have a version box? That’s the most commonly missing piece of information that we need, and often have to ask for.

I saw you can have drop downs to select which could just be v1/v1.1/v1.2/preview > 1.2 or something similar

Piedone commented 2 years ago

That's a good idea! Unless there are objections or other suggestions, I'd add this.

sebastienros commented 2 years ago

As long as I can create an issue from a blank template. Sometimes I just don't file issues because it's like I am being interogated.

Piedone commented 2 years ago

Probably we'd need to keep such quick notes mostly intended for core contributors somehow separate then, otherwise everyone would just take the easy route (as they mostly do now). The point of these templates is to gather all the necessary information (even if the one who creates the issue thinks something is trivial or self-explanatory, it might not be as such for everyone) and to indeed ask the person to put in the effort. (Otherwise, those who chime in under the issue have to continue the interrogation :) which will probably collectively take more time in the end.)

Recently, I've opened a bug report here: https://github.com/VerifyTests/DiffEngine/issues/new?assignees=&labels=&template=bug_report.md I painstakingly filled out everything, and then came the bonus last question: one should even submit a PR! I was like, "dude, I'm just a user, I really don't want to dig into your code for some most possibly trivial change". While I certainly wouldn't go as far as asking everyone to open PRs, I understood that it's reasonable to ask people to put in those 5-10 minutes into opening an issue so it's actually actionable by others (and you don't have to start with an investigation of what the person really wants). It's a tiny price to pay for all the free software you otherwise get, and the free fix you'll most likely also get. It raises the barrier of entry but thus acts as a filter