Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upupdate bug-report flow #3646
update bug-report flow #3646
Conversation
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. |
jtpavlock
Jun 28, 2020
Author
Contributor
this obviously turns into a link if the page existed
this obviously turns into a link if the page existed
|
Seems great, and the There are two things about the old, slightly-more-specific template that I thought were effective:
|
|
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. |
|
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. |

Formed in 2009, the Archive Team (not to be confused with the archive.org Archive-It Team) is a rogue archivist collective dedicated to saving copies of rapidly dying or deleted websites for the sake of history and digital heritage. The group is 100% composed of volunteers and interested parties, and has expanded into a large amount of related projects for saving online and digital history.

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 :)