The Wayback Machine - https://web.archive.org/web/20201005105352/https://github.com/beetbox/beets/pull/3646
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 flow #3646

Open
wants to merge 4 commits into
base: master
from
Open

update bug-report flow #3646

wants to merge 4 commits into from

Conversation

@jtpavlock
Copy link
Contributor

@jtpavlock jtpavlock commented Jun 28, 2020

So, I think the bug template could use some attention. My proposal is to create a wiki page that would go through the proper steps of reporting a bug and self-diagnosis, then hopefully have the template as a nice plug and play of the proper info. I made a sample wiki page at my fork here

I also added a dropdown for the config file that can also be set to be open automatically. I figured this could make some of those issues with painfully long configs easier to read. The template isn't as explicit as before on purpose, to hopefully encourage users to take a look at the wiki page :)

So, I think the bug template could use some attention. My proposal is to create a wiki page that would go through the proper steps of reporting a bug and self-diagnosis, then hopefully have the template as a nice plug and play of the proper info. I made a sample wiki page at my fork [here](https://github.com/jtpavlock/beets/wiki/How-to-create-a-good-bug-report)

I also added a dropdown for the config file that can also be set to be open automatically. I figured this could make some of those issues with painfully long configs easier to read. The template isn't as explicit as before on purpose, to hopefully encourage users to take a look at the wiki page :)

TODO:
- [ ] provide an example bug report on the wiki page?
-->

### Problem
Hi there, thank you for reporting a bug! Please read our `how to create a good bug report` wiki page to expedite the process of diagnosing the issue.

This comment has been minimized.

@jtpavlock

jtpavlock Jun 28, 2020
Author Contributor

this obviously turns into a link if the page existed

@sampsyo
Copy link
Member

@sampsyo sampsyo commented Jun 28, 2020

Seems great, and the <details> thing seems like a good idea for the configuration.

There are two things about the old, slightly-more-specific template that I thought were effective:

  • The rigid format that suggested that people paste a command and an output at the top. This doesn't always apply, but it's good for about 90% of cases. With the more common but more vague "steps to reproduce"/"actual result" sections, I notice that people are sometimes encouraged to write in free-form prose about what they tried to do. That's nice to have too, but only when it's accompanied by the actual command and and actual, complete paste of the output. Including that beet -vv there helps people immediately see what they need to do to get that invaluable debug output.
  • The "Turning off plugins made problem go away (yes/no):" prompt is also helpful because so many problems can be traced to plugins—but we really depend on people experimentally figuring out which one. So while it would be great to describe the process of disabling plugins one at a time in the accompanying wiki page, I like having that line there to be an obvious, visceral reminder that this should be your first recourse when trying to track down the root cause of a problem.
jtpavlock added 2 commits Jun 28, 2020
@jtpavlock
Copy link
Contributor Author

@jtpavlock jtpavlock commented Jun 28, 2020

That makes sense, I added a bit more handholding in the template as you suggest borrowing from the old template.

Keep in mind you're the one dealing with 99.9% of the issues on this repo, so I'm just trying to help you out. If you feel any of these changes are worse for you, you won't hurt my feelings.

@jtpavlock
Copy link
Contributor Author

@jtpavlock jtpavlock commented Jul 28, 2020

So I goofed and removed my fork and consequently the "how to create a good bug report" wiki page. Not sure if any of these changes are worth merging (perhaps just the config dropdown?), but I can rebase this and change whatever.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
You can’t perform that action at this time.