Re: [libvirt PATCH] gitlab: Ask users not to attach screenshots to bug reports
On Fri, Feb 10, 2023 at 02:27:46AM -0800, Andrea Bolognani wrote:
On Fri, Feb 10, 2023 at 09:50:25AM +0000, Daniel P. Berrangé wrote:
> On Fri, Feb 10, 2023 at 10:34:11AM +0100, Andrea Bolognani wrote:
> > +<!-- Please DO NOT ATTACH SCREENSHOTS to the bug report. Provide all
information as plain text -->
>
> I think this is pretty user hostile. When filing bugs, the more rules a
> project imposes on the bug report, the less likely I am to go ahead with
> filing it, especially when the rules are worded in a very direct manner
> that makes it feel like you'll be flamed for getting it wrong.
For the person reporting the bug, taking a screenshot and attaching
it or copying and pasting the corresponding text shouldn't make any
difference in terms of effort. If anything, the latter is probably
going to be less work.
I wouldn't be so sure of that. I can very easily see people connecting
to Linux hypervisors from a Windows terminal client and finding it
easier to just hit 'PrtSr' key on their keyboard, instead of copying
the files over with an scp client.
Yeah, the wording I've proposed can perhaps be seen as hostile.
Any
suggestions on how to improve it, while still making it pop out so
that users aren't likely to miss it?
I'm not convinced the problem of screenshotting XML docs is frequent
enough top justify explicitly mentioning, certain not in the issue
template. As most something in the separate docs about how to improve
issue reports.
> IMHO if someone provides a bug report with a screenshot and
there is not
> sufficient accompanying information, just nicely ask them to explain the
> problem in a little more detail. We need todo that with plenty of bugs
> which don't have screenshots either, and screenshots can be helpful in
> some cases.
Sure, but there's a difference between asking for more details, which
can always be done as a follow-up, and asking users to provide
information as plain text instead of screenshots. In the latter case,
once the screenshot has been attached, that's it, there's no going
back.
Why can't we ask users to add the XML as text afterwards ? I've often
done just that when people have attached images, if it was useful to
me to have it in text format.
With regards,
Daniel
--
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o- https://fstop138.berrange.com :|
|: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|