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

Add issue-forms for new bugs/feature-requests/other #263

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

Masgalor
Copy link
Contributor

@Masgalor Masgalor commented Jan 4, 2024

I had a little time on my hands, so I've created a form for bugreports as requested in #27.

I wasn't sure how technically I should get with those questions so I decided to stay closer to the side of people which don't know that much about their system. However, just let me know what you want changed or added.

Unfortunately it is not easy to review issue-forms because they are not rendered correctly in the file preview.
You can test my current form in this repo or create an empty one yourself and test it there.

@AsherGlick
Copy link
Owner

I do think we eventually want something like this. I dont know what exactly it will look like so I will just share my general thoughts without necessarily providing guidance or solutions:

  • Checkbox for "All components are upgraded" might be a good general idea but it is pretty hard for a user to confirm. burrito-link does not even really have a version number so the only way to guarantee this is by downloading whatever the newest version of the program is.
  • I like the dropdown for asking about burrito-link. I might change it to reference "burrito link" specifically by name, and switch the ordering to have d3d11.dll on top as it is the recommended default. Even though the standalone version was first.
  - type: dropdown
    id: burrito_link_install_method
    attributes:
      label: Burrito Link
      description: How did you install burrito link?
      options:
        - DLL (d3d11.dll)
        - DLL (arcdps_burritolink.dll)
        - Standalone (burrito_link.exe)
        - Other
      default: 0
  • The desktop environment checkboxes are a little wonky. There is a lot of mixed info being presented there. They also translate into "tasks" in the issue itself, which lead to "2/7 tasks complete" for "My desktop is Gnome". The checkboxes are also limited in what the user can select. EG: AwesomeWM, XFCE, etc
  • The inxi -Gxxx && wmctrl -m optional info is probably sufficient to replace those checkboxes. It is an ongoing project to determine even what info is necessary for debugging, you can find my incoherent ramblings https://github.com/AsherGlick/Burrito/wiki/Graphics-Stacks
  • Github's Issue UI is not fantastic for "other" issues when templates exist. So we probably also want to include a template for feature requests, and maybe a template for questions, even if that template is just redirecting folks over to the discussions page.

@AsherGlick
Copy link
Owner

Checkbox for "All components are upgraded" might be a good general idea but it is pretty hard for a user to confirm. burrito-link does not even really have a version number so the only way to guarantee this is by downloading whatever the newest version of the program is.

Thinking about this more this question should just ask for the version number of Burrito/Burrito Link (once we figure out a good way to surface that info to the user) instead of a checkbox for "it is up to date". Because when we look back at old bugs we can see what version number those were submitted for instead of that they were using the most up to date version at the time the issue was submitted.

@Masgalor
Copy link
Contributor Author

Masgalor commented Jan 5, 2024

Thinking about this more this question should just ask for the version number of Burrito/Burrito Link (once we figure out a good way to surface that info to the user) instead of a checkbox for "it is up to date".

My idea with this checkbox was to give the user a hint to check for an update before opening a report.
I spent too much time of my life hunting bugs that didn't even exist anymore, because the customer reporting the bug used some ancient version. So I would like to keep the checkbox, not because it carries some useful information, but because it (hopefully) rises the awareness for software updates.
It makes sense to have the version in the report especially for long living issues, but there is no way for the user to know what version they are running, so this must be an optional question. I added an dropdown element for this, we need to remember to update it after a release.

I changed the form with your other mentions in mind, so have another look if you find the time.
I also added other forms for feature-requests and freestyle questions.

@Masgalor Masgalor changed the title Create a form for bugreports Add issue-forms for new bugs/feature-requests/other Jan 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants