Add Issue Forms #10865

MatteoGheza · 2022-09-03T12:25:42Z

As discussed on Zulip, I added issue forms (issue templates but with defined input types and with better UI for the user) for bug reports and feature requests.
As requested, the only required input is the description.
If you want to try this, check this example repo.

ronso0 · 2022-09-03T16:31:06Z

Thanks for starting this!

re OS combobox:
considering Mixxx is built on many linux distros which can't be covered by a combobox, I think the OS/version should be a regular line edit. The question should be "What operating system and version are you running?"

Holzhaus · 2022-09-03T18:46:45Z

Thanks for starting this!

re OS combobox:
considering Mixxx is built on many linux distros which can't be covered by a combobox, I think the OS/version should be a regular line edit. The question should be "What operating system and version are you running?"

A lot of users don't know what an OS is, so maybe we should give an example?

What operating system and version are you running (e.g. Windows 11, macOS Big Sur, Ubuntu 22.04, ...)?

daschuer

Thank you for bringing that up.

.github/ISSUE_TEMPLATE/bug.yaml

.github/ISSUE_TEMPLATE/feature_request.yaml

Holzhaus · 2022-09-04T10:31:53Z

Please add sur (lowercase) to .codespellignore to fix the pre-commit issue:

.github/ISSUE_TEMPLATE/bug.yaml:27: Sur ==> Sure, sir

.github/ISSUE_TEMPLATE/bug.yaml

ronso0 · 2022-09-05T18:11:44Z

@MatteoGheza Would you mind updating your demo repo? Wuld be nice if we could test this 'live'.

daschuer · 2022-09-06T07:32:30Z

.github/ISSUE_TEMPLATE/feature_request.yaml

+    id: description
+    attributes:
+      label: Feature Description
+      description: What feature would you like to see added to Mixxx?


I think we should swap the title description with this one.

Holzhaus

Thanks. IIRC it's also possible to add links, right? If so we could add a third option in addition to "Bug" and "Feature Request": something like "Question" that is a link to the discourse board.

Holzhaus · 2022-09-06T08:08:18Z

.github/ISSUE_TEMPLATE/bug.yaml

@@ -0,0 +1,27 @@
+name: 🐛 Bug Report


This caterpillar is easily confused with a snake. What do you think about using 🪲 (U+1FAB2) instead?

Unfortunately I only see a gray rectangular for the proposed alternative on my mobile.

I had also this idea initially, than I realized that 🐛, U+1F41B is called Bug.

🐛 was added in Emoji 1.0 while 🪲 was added in 13.0 (2020)... I still prefer 🪲

MatteoGheza · 2022-09-06T09:36:32Z

@MatteoGheza Would you mind updating your demo repo? Wuld be nice if we could test this 'live'.

Done. https://github.com/MatteoGheza/mixxx-issue-templates-PoC/issues/new/choose

MatteoGheza · 2022-09-06T09:38:04Z

Thanks. IIRC it's also possible to add links, right? If so we could add a third option in addition to "Bug" and "Feature Request": something like "Question" that is a link to the discourse board.

Yes, I think we can do something like this (as an optional field).

.github/ISSUE_TEMPLATE/bug.yaml

Swiftb0y · 2022-09-06T15:24:03Z

Thanks. IIRC it's also possible to add links, right? If so we could add a third option in addition to "Bug" and "Feature Request": something like "Question" that is a link to the discourse board.

I don't think thats possible. This is the closest thing I came up with that should validate.

name: 🤔 Question
description: |
  Please use [our forums](https://mixxx.org/forums) for questions
body:
  # body must contain at least one non-markdown field
  # https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms#body-must-contain-at-least-one-non-markdown-field
  - type: dropdown
    attributes:
      label: |
        Please use [our forums](https://mixxx.org/forums) for questions
      options:
        - Please use [our forums](https://mixxx.org/forums) for questions
    validations:
      required: true

Co-authored-by: Swiftb0y <12380386+Swiftb0y@users.noreply.github.com>

MatteoGheza · 2022-09-06T19:04:09Z

.github/ISSUE_TEMPLATE/config.yml

+contact_links:
+  - name: 🤔 Question
+    url: https://mixxx.org/forums
+    about: Please use our forums for questions


I don't think thats possible.

It's possible to add links (with title and description) as "contact links". What do you think about this @Holzhaus?
Remember that you can try this at https://github.com/MatteoGheza/mixxx-issue-templates-PoC/issues/new/choose

Great, exactly what I had in mind! Thanks.

Good catch. I didn't know there was an ISSUE_TEMPLATE/config.yml. I was only digging through the documentation of the forms yaml scheme.
This solution is much better than my proposal.

Nitpick: instead of arbitrary Open let's use Go to Mixxx user forum?

if possible at all...

I think this is not possible... The config file has not more options than this.

Holzhaus · 2022-09-06T19:04:12Z

Thanks. IIRC it's also possible to add links, right? If so we could add a third option in addition to "Bug" and "Feature Request": something like "Question" that is a link to the discourse board.

I don't think thats possible. This is the closest thing I came up with that should validate.

name: 🤔 Question
description: |
  Please use [our forums](https://mixxx.org/forums) for questions
body:
  # body must contain at least one non-markdown field
  # https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms#body-must-contain-at-least-one-non-markdown-field
  - type: dropdown
    attributes:
      label: |
        Please use [our forums](https://mixxx.org/forums) for questions
      options:
        - Please use [our forums](https://mixxx.org/forums) for questions
    validations:
      required: true

Have a look at:
https://github.com/beetbox/beets/blob/master/.github/ISSUE_TEMPLATE/config.yml

And the result:
https://github.com/beetbox/beets/issues/new/choose

MatteoGheza · 2022-09-06T19:05:30Z

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false


Would you prefer to enable the possibility to add issues without using a template?

I'm torn on this.

For bugs and feature requests, this is not neccessary. We don't have some complex JIRA-like form with dozens of fields, just a description + affected version + OS.

However, I think we may sometimes want to create issues as TODO items (e.g. for project boards) and then these two options may not be a good fit. Maybe we should add a new type "Task" for those kind of issues? Or could we restrict blank issues for contributors only?

👍 "TODO" for contributors only

Or could we restrict blank issues for contributors only?

If thats possible, that would be ideal IMO.

If not, we should have blank issues enabled for all IMO.

I think that with this config file we can't do something like that. I'll enable blank issues in the config.

daschuer

LGTM, Thank you.

Swiftb0y

Did we come to a conclusion on 🐛 vs 🪲 @Holzhaus ?

Holzhaus

Thank you, this is definitely an nice improvement.

I'd tlike to merge this now - if someone wants to fine-tune the details later on, we can still do this in a follow-up PR. Just waiting for approval by @Swiftb0y.

Holzhaus · 2022-09-06T21:52:31Z

Did we come to a conclusion on bug vs beetle @Holzhaus ?

I do prefer the beetle over the caterpillar. Unsure how well it's supported, it works fine on my phone, laptop and desktop. And the icon/emoji is just for eye candy, so even if a device does not support it, everything stays usable. But I'm not super passionate about it. If you'd open a PR, I'd approve it 😄

ronso0 · 2022-09-06T21:54:19Z

Thanks @MatteoGheza
I'm sure this will save time reviewing bug reports

Add Issue Forms

0615c94

daschuer requested changes Sep 4, 2022

View reviewed changes

.github/ISSUE_TEMPLATE/bug.yaml Outdated Show resolved Hide resolved

.github/ISSUE_TEMPLATE/bug.yaml Outdated Show resolved Hide resolved

.github/ISSUE_TEMPLATE/bug.yaml Outdated Show resolved Hide resolved

.github/ISSUE_TEMPLATE/feature_request.yaml Outdated Show resolved Hide resolved

Update issue templates

7e44250

Add "Sur" to .codespellignore for "MacOs Big Sur"

86c9f04

MatteoGheza marked this pull request as ready for review September 4, 2022 11:28

MatteoGheza commented Sep 4, 2022

View reviewed changes

.github/ISSUE_TEMPLATE/bug.yaml Show resolved Hide resolved

daschuer reviewed Sep 6, 2022

View reviewed changes

Holzhaus reviewed Sep 6, 2022

View reviewed changes

Swap description and title in feature_request.yaml

ac023d6

Swiftb0y reviewed Sep 6, 2022

View reviewed changes

.github/ISSUE_TEMPLATE/bug.yaml Show resolved Hide resolved

MatteoGheza and others added 2 commits September 6, 2022 20:34

Update .github/ISSUE_TEMPLATE/bug.yaml

30c00e1

Co-authored-by: Swiftb0y <12380386+Swiftb0y@users.noreply.github.com>

Add issues config.yml

845a749

MatteoGheza commented Sep 6, 2022

View reviewed changes

Re-enable blank issues

44b0c34

Holzhaus requested a review from daschuer September 6, 2022 20:50

daschuer approved these changes Sep 6, 2022

View reviewed changes

Swiftb0y requested changes Sep 6, 2022

View reviewed changes

Holzhaus approved these changes Sep 6, 2022

View reviewed changes

Holzhaus requested a review from Swiftb0y September 6, 2022 21:35

Swiftb0y approved these changes Sep 6, 2022

View reviewed changes

Swiftb0y merged commit 58459b6 into mixxxdj:main Sep 6, 2022

MatteoGheza deleted the issue_templates branch September 6, 2022 22:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Issue Forms #10865

Add Issue Forms #10865

MatteoGheza commented Sep 3, 2022

ronso0 commented Sep 3, 2022

Holzhaus commented Sep 3, 2022

daschuer left a comment

Holzhaus commented Sep 4, 2022

ronso0 commented Sep 5, 2022

daschuer Sep 6, 2022

Holzhaus left a comment

Holzhaus Sep 6, 2022

daschuer Sep 6, 2022

Swiftb0y Sep 6, 2022 •

edited

Loading

MatteoGheza commented Sep 6, 2022

MatteoGheza commented Sep 6, 2022

Swiftb0y commented Sep 6, 2022

MatteoGheza Sep 6, 2022

Holzhaus Sep 6, 2022

Swiftb0y Sep 6, 2022

ronso0 Sep 6, 2022

ronso0 Sep 6, 2022

MatteoGheza Sep 6, 2022

Holzhaus commented Sep 6, 2022

MatteoGheza Sep 6, 2022

Holzhaus Sep 6, 2022

ronso0 Sep 6, 2022

Swiftb0y Sep 6, 2022

MatteoGheza Sep 6, 2022 •

edited

Loading

daschuer left a comment

Swiftb0y left a comment

Holzhaus left a comment •

edited

Loading

Holzhaus commented Sep 6, 2022

ronso0 commented Sep 6, 2022

Add Issue Forms #10865

Add Issue Forms #10865

Conversation

MatteoGheza commented Sep 3, 2022

ronso0 commented Sep 3, 2022

Holzhaus commented Sep 3, 2022

daschuer left a comment

Choose a reason for hiding this comment

Holzhaus commented Sep 4, 2022

ronso0 commented Sep 5, 2022

Choose a reason for hiding this comment

Holzhaus left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Swiftb0y Sep 6, 2022 • edited Loading

Choose a reason for hiding this comment

MatteoGheza commented Sep 6, 2022

MatteoGheza commented Sep 6, 2022

Swiftb0y commented Sep 6, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Holzhaus commented Sep 6, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MatteoGheza Sep 6, 2022 • edited Loading

Choose a reason for hiding this comment

daschuer left a comment

Choose a reason for hiding this comment

Swiftb0y left a comment

Choose a reason for hiding this comment

Holzhaus left a comment • edited Loading

Choose a reason for hiding this comment

Holzhaus commented Sep 6, 2022

ronso0 commented Sep 6, 2022

Swiftb0y Sep 6, 2022 •

edited

Loading

MatteoGheza Sep 6, 2022 •

edited

Loading

Holzhaus left a comment •

edited

Loading