Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify bug report form #14154

Closed
wants to merge 3 commits into from

Conversation

rubenwardy
Copy link
Member

@rubenwardy rubenwardy commented Dec 23, 2023

The bug report form is too long and contains questions that are frequently irrelevant and confusing to reporters

With #13605, we could simplify this even further

To do

This PR is Ready for Review.

Copy link
Member

@grorp grorp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although this is much better than before, I still prefer the text-based issue template :)

For example, you can submit issues about the Minetest Game (the official game of Minetest) in its own repository.

If we're already at it, we could remove "(the official game of Minetest)".

.github/ISSUE_TEMPLATE/bug_report.yaml Outdated Show resolved Hide resolved
@grorp grorp added UI/UX @ Meta Not strictly related to MT development labels Dec 23, 2023
label: OpenGL version
placeholder: "Example: 4.6"
label: System Information
description: Operating System? CPU model? GPU? OpenGL version?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please keep the instructions to get "Active renderer" and "Irrlicht device" fields from credits tab.
This is important now that we're switching to SDL, and might also switch to opengl 3.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then let's add a short blurb about how to find that information.

I recently opened an issue and I personally found it daunting and I work on MT. :(

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is one of the things I really wanted to remove as it's fairly meaningless to users and not relevant to all issues. The current form doesn't even say what an Irrlicht device is or how to find it out.

This is included as part of the version information if you do --version. We need #13605

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then let's add a short blurb about how to find that information.

The current form doesn't even say what an Irrlicht device is or how to find it out.

It says:

For graphical and input-related issues. You can find these in the About tab in the mainmenu.

This used to be above active renderer and irrlicht device. It was incorrectly moved to active renderer only on the change to non-text-only issue form.


not relevant to all issues

That's because you can usually conclude it from the OS and minetest version. We can maybe write that the information needs only to be supplied if non-default build options were used.


This is included as part of the version information if you do --version.

(Non-trivial to add in --version, because as of now it doesn't create an irrlicht device.)

You also need to consider that issues may be opened from the current stable version, i.e. 5.8.0, where there's no export button or similar for this.

@Desour
Copy link
Member

Desour commented Dec 23, 2023

If fields are optional and part of a text template, I'd prefer a list of things that one can report (such as OS, cpu, ...) over a mashed together "put OS, cpu, ... here", because in former the issue creator can just stupidly go through the checklist, and answer relevant fields, while in latter it's unclear what specifically we'd want to know from them.
I don't remember having multiple fields clobbered the issue form when it was text based.

If we really want to keep the non-text template for some reason, can we maybe pre-fill the "System Information" field with a template text (as opposed to the placeholder thing that you can't see anymore after you enter a letter)?
This template could then list all the things to report.

@sfan5 sfan5 added the Action / change needed Code still needs changes (PR) / more information requested (Issues) label Dec 25, 2023
@sfan5
Copy link
Member

sfan5 commented Feb 16, 2024

Possibly obsoleted by 8c3a6a8

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Action / change needed Code still needs changes (PR) / more information requested (Issues) @ Meta Not strictly related to MT development One approval ✅ ◻️ Possible close UI/UX
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants