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

Update bug_report.yml #12991

Merged
merged 4 commits into from
Oct 14, 2023
Merged

Update bug_report.yml #12991

merged 4 commits into from
Oct 14, 2023

Conversation

w-e-w
Copy link
Collaborator

@w-e-w w-e-w commented Sep 2, 2023

Description

update bug report template

add a checklist with simple debug instruction

use placehoder for example of what should be filled in
so that people have to actually fill in and not just leave the template in
image
and give actual examples of what we actually expect

perfect example of a type of issue post that I'm trying to avoid
https://github.com/AUTOMATIC1111/stable-diffusion-webui/issues/12996

demo of how it looks when filling the form
https://github.com/w-e-w/ext-temp-test/issues/new?assignees=&labels=bug-report&projects=&template=bug_report.yml&title=%5BBug%5D%3A+
demo of how it looks after it's posted
w-e-w/ext-temp-test#31

Checklist:

@AUTOMATIC1111
Copy link
Owner

Those placeholders look weird...

Can we instead put those texts into the description above the edit box and explicitly mention that the are examples?

@w-e-w
Copy link
Collaborator Author

w-e-w commented Sep 9, 2023

which placeholder you think it's weird specifically, or do you mean all of them

as we have seen in practice, people don't read descriptions
lots of people don't know what is sysinfo and those who do often upload it as raw text

it's driving me insane, I have mentally copied and then re-uploaded it has file several times now

I think placeholder makes it more obvious and can give actual demonstration of what we want

if you think some placeholder is too much feel free to change them
feel free to make suggestions or change them

@AUTOMATIC1111
Copy link
Owner

People who don't read descriptions will not read placeholders. The way it is in the PR is confusing even for me. I feel that all placeholders are too much and all examples should be in descriptions, not in placeholders.

@w-e-w
Copy link
Collaborator Author

w-e-w commented Sep 9, 2023

less placeholder version
Issue: Bug Report v2

original for comparison

only on test report not pushed to this branch yet

@AUTOMATIC1111
Copy link
Owner

Looks great!

@w-e-w
Copy link
Collaborator Author

w-e-w commented Oct 3, 2023

pushed less placeholder version

@AUTOMATIC1111 AUTOMATIC1111 merged commit 6fe16a9 into dev Oct 14, 2023
6 checks passed
@AUTOMATIC1111 AUTOMATIC1111 deleted the but-report-template branch October 14, 2023 05:36
@w-e-w w-e-w mentioned this pull request Dec 4, 2023
@w-e-w w-e-w mentioned this pull request Dec 16, 2023
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.

3 participants