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.

Sign up for GitHub

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

Jump to bottom

Simplify bug report form #14154

Closed
wants to merge 3 commits into from
Closed

Simplify bug report form #14154

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3a8f52e
Simplify bug report form
rubenwardy Dec 23, 2023
214ffdc
sysinfo shouldn't be required
rubenwardy Dec 23, 2023
b9d447f
fixes
rubenwardy Dec 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
52 changes: 7 additions & 45 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
View file
Open in desktop
Expand Up @@ -6,9 +6,9 @@ body:
attributes:
value: |
Please note the following:

1. **Please update your Minetest Engine to the latest stable or dev version** before submitting bug reports. Make sure the bug is still reproducible on the latest version.
2. This page is for reporting the bugs of **the engine itself**. For bugs in a particular game, please [search for the game in the ContentDB](https://content.minetest.net/packages/?type=game) and submit a bug report in their issue trackers.
* For example, you can submit issues about the Minetest Game (the official game of Minetest) [in its own repository](https://github.com/minetest/minetest_game/issues).
3. Please provide as many details as possible for us to spot the problem quicker.
- type: textarea
attributes:
Expand All @@ -19,7 +19,7 @@ body:
You can use `minetest --version` to find it.
You can also refer to the "About" tab of the menu.
placeholder: |
Example:
Example:
Minetest 5.7.0-dev-ca13c51 (Linux)
Using Irrlicht 1.9.0mt9
Using LuaJIT 2.1.0-beta3
Expand All @@ -33,58 +33,20 @@ body:
render: "true"
validations:
required: true
- type: input
attributes:
label: Active renderer
description: For graphical and input-related issues. You can find these in the About tab in the mainmenu.
placeholder: "Example: OpenGL 4.6.0"
validations:
required: false
- type: input
attributes:
label: Irrlicht device
description:
placeholder: "Example: X11"
validations:
required: false
- type: input
attributes:
label: Operating system and version
description: It is recommended to upgrade your operating system to see if the problem still exists.
placeholder: "Example: Ubuntu 22.04"
validations:
required: true
- type: input
attributes:
label: CPU model
description: Usually found in system settings.
placeholder: "Example: Intel i5-2410M (4) @ 2.900GHz"
validations:
required: false
- type: markdown
attributes:
value: The GPU model and OpenGL version can be omitted if the bug is not a graphical issue.
- type: input
attributes:
label: GPU model
description: Usually found in system settings.
placeholder: "Example: NVIDA GeForce RTX 4090"
validations:
required: false
- type: input
- type: textarea
attributes:
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.

validations:
required: false
- type: textarea
attributes:
attributes:
label: Summary
description: Describe your problem here.
validations:
required: true
- type: textarea
attributes:
attributes:
label: Steps to reproduce
description: Explain how the problem has happened, providing a minimal test (i.e. a code snippet reduced to the bone) where possible.
validations:
Expand Down