Bug/Feature tracker
-
Alright, so let's try dusting off the GitHub issues list. I think we need to talk about a set of requirements that needs to be met for all bug reports that minimizes the time for me to reproduce (because it highly increases the chances of it being actually fixed).
So:
- exact commit that is used (the SHA as link, GitHub should resolve that automatically)
- A HISE Snippet as formatted code block. If the example needs external resources, a Zip file containing the minimal project folder (I think you can upload ZIP files in a GitHub issue).
- an exact description of what's not working as expected (with a video screencast only if it's really necessary (eg. UI blips or other interaction bugs that are hard to describe in words).
If all these criterias are met, you can add the label
Valid Bug report. I'll take one of the more recent bugs listed here as an example (probably the SliderPack thingie), this should act as a good blueprint. -
I like it!
@christoph-hart said in Bug/Feature tracker:
A HISE Snippet as formatted code block. If the example needs external resources
Would it be difficult for snippets to inline included js files?
Oh might be a good idea to setup an issue template for bug reports - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository
Libre Wave - Freedom respecting instruments and effects
My Patreon - HISE tutorials
YouTube Channel - Public HISE tutorials -
@d-healey yes that templates thingie is a good idea, I'll check it out.
-
@christoph-hart I PM'ed you to help finding a solution recently with no answer, I hope now we're getting somewhere reliably
-
@ustk yeah sorry I forgot to respond but you definitely laid the seed in my brain for this subject ;)
-
Alright, I've added an example issue for one of the most recent bugs (plus I'll post a "moved to GitHub Issues" to the forum topic so we know it was taken to the next level...
-
@christoph-hart said in Bug/Feature tracker:
you can add the label Valid Bug report
I think only the repo owner can add labels
Libre Wave - Freedom respecting instruments and effects
My Patreon - HISE tutorials
YouTube Channel - Public HISE tutorials -
@d-healey Nice, even more power for me!
-
@christoph-hart So this system is adopted?
Your are lucky I don't have much time at the moment but the list is ready, right there...
:) -
Keep thinking about this and maybe it's a good idea to still report a bug first in the forum and then if it's really confirmed, we move it to GitHub.
I'm just trying to think of ways to keep the GitHub issues a super clean list of (rather high priority) bugs I need to work through, because I can imagine that if everybody just writes every bug ever there we're back at square one.
-
@christoph-hart said in Bug/Feature tracker:
maybe it's a good idea to still report a bug first in the forum
Maybe back to the Mantis idea so issues can be organized?
-
@christoph-hart That's what I imagined. Bug have to be confirmed by the community first as eligible to open an issue, so the git isn't cluttered by false alarms.
I agree that a priority tag should be attached to the issue. If it isn't a problem with a small list it becomes to be a problem with 30 lines, where high priority bugs have the risk to be drowned. -
@christoph-hart Low priority should also be listed so they aren't lost, and people can see it as already been raised at a glance. So definitely a more adapted tool would be better (I don't know Mantis).
-
Alright, then we have a
Confirmed Buglabel for each bug report that goes through the "bug vetting process" (issue raised in the forum and confirmed by multiple parties). When a bug report is raised in the forum, we'll discuss it and decide whether to stick aLow Prioritylabel or aHigh Prioritylabel to it. When this is done, the forum topic will be closed and I'll move it to GitHub issues.Sounds good? This gives us enough flexibility to talk and discuss while keeping the issue list clean and organized.
-
@christoph-hart said in Bug/Feature tracker:
the forum topic will be closed
Closed = still viewable and no new replies?
Libre Wave - Freedom respecting instruments and effects
My Patreon - HISE tutorials
YouTube Channel - Public HISE tutorials -
@d-healey yes. You can comment on the issue from then on if there‘s something to add but this will prevent that the conversation is split between the places.
-
Also maybe we can tag the forum topics that are supposed to lead to a GitHub issue with a certain tag (eg. "BUG TRACKER"), then it's easier to keep track of them.
Lots of rules :)
-
This is great! I am happy to see this happening.
-
@christoph-hart And either mark the thread as FIXED or even delete it, unless there's a good reason to keep it if the issue is fixed?
-
@ustk not sure if we need to delete the topic - when its locked it will automatically be buried by other topics.
I would also suggest to not marking the forum topic fixed - if you want the information of which bugs are still active, just use the Github issue list (Closed issues will automatically be removed from the list).
