lmms icon indicating copy to clipboard operation
lmms copied to clipboard

Add GitHub issue forms for bug reports and feature requests

Open TechnoPorg opened this issue 1 year ago • 1 comments

Closes #6823

Issue forms are technically in "beta", but they've been in beta for 3 years, so I think it's safe to say that they're not going anywhere.

The use of issue forms provides a cleaner experience both for users and contributors:

  • Users receive more guidance on the specifics of submitting an issue thanks to the ability for contributors to provide additional context in the form.
  • It provides a more consistent, centralized method for contributors to ensure that all issues contain the necessary information in a cleanly structured format.

I tried to strike a balance between keeping the content of the existing issue template, while also providing a few more specifics to ensure higher quality bug reports. Some general inspiration was taken from Godot's issue templates.

TechnoPorg avatar Feb 12 '24 23:02 TechnoPorg

It can be tested out on my fork.

What the forms look like in action:

image

image

TechnoPorg avatar Feb 13 '24 23:02 TechnoPorg

@DomClark Thanks for taking the time to give such a thorough review! I've made some changes that should address most of your concerns, so if you could give it a second look that would be great.

TechnoPorg avatar Feb 22 '24 00:02 TechnoPorg

One more thing - do these files pass yamllint? Johannes is introducing a .yamllint configuration file in #6983, which you could use for testing. It specifies a maximum line length of 120 characters, which I suspect may be a bit short for these files, so you may need to disable the line length rule at appropriate places (perhaps even for the whole file if there are enough places to make the linter comments spammy).

DomClark avatar Mar 05 '24 23:03 DomClark

Sorry for being particularly picky with this - it's going to be viewed by people who may be less skilled with technology, or English, so I'm trying to polish it a bit.

No problem at all - I actually really appreciate it, so thanks! We both want this PR to be as good as possible, because it deals with one of the most important parts of the average user's experience.

One more thing - do these files pass yamllint?

I added a yamllint directive to disable line length checks for the entire file, because there is no way to put comments in a multiline string, so it just can't be done on a per-line basis.

Otherwise, I've addressed all the review comments you left plus the one about imperative instructions, so :crossed_fingers: it's good now. Is there anything not there that you'd like to see added?

TechnoPorg avatar Mar 10 '24 02:03 TechnoPorg