[libvirt PATCH] gitlab: Ask users not to attach screenshots to bug reports

[Peter Krempa]

On Fri, Feb 10, 2023 at 10:48:25 +0100, Michal Prívozník wrote:
> On 2/10/23 10:34, Andrea Bolognani wrote:
> > Hopefully including this request in ALL CAPITAL LETTERS in the
> > issue template will cut down on the number of screenshots that
> > end up cluttering bug reports by at least a tiny bit.
> > 
> > Signed-off-by: Andrea Bolognani <abologna at redhat.com>
> > ---
> >  .gitlab/issue_templates/bug.md | 1 +
> >  1 file changed, 1 insertion(+)
> > 
> > diff --git a/.gitlab/issue_templates/bug.md b/.gitlab/issue_templates/bug.md
> > index f220671a06..b923be0ca0 100644
> > --- a/.gitlab/issue_templates/bug.md
> > +++ b/.gitlab/issue_templates/bug.md
> > @@ -17,3 +17,4 @@
> >  ## Additional information
> >  <!-- Attach XML configs, logs, stack traces, etc. Compress the files if necessary -->
> >  <!-- See https://libvirt.org/kbase/debuglogs.html on how to configure logging -->
> > +<!-- Please DO NOT ATTACH SCREENSHOTS to the bug report. Provide all information as plain text -->
> 
> Since we're changing our template, would it make sense to request users
> to at least attempt to reproduce on something recent? I've seen reports
> with ~3 years old libvirt. And given the pace libvirt's development is
> moving it's very likely that the issue is fixed. And even if it wasn't -
> we stop wasting our time trying to reproduce on current master only to
> find out the issue was fixed a while ago.
> 
> I understand that some distros move slowly, but usually their users file
> bugs against distro bugzilla.

Originally I designed the bug template with way more prompts and during
review we've agreed to do something minimal and link to a bigger
document.

This is so that users are not discouraged by a wall of text.

I wonder whether we should do a better version of:

https://libvirt.org/bugs.html#how-to-file-high-quality-bug-reports

And add a more demanding prompt for users to read it. We can then
include the wording to encourage only filing with recent versions on
supported platforms, as well as ask to not attach screenshots.

In the end in many cases issue reports are incomplete regardless of even
the inline prompt which asks for VM XML and debug logs.