Re: [PATCH v3 1/2] GitLab: Add "Bug" issue reporting template

[Daniel P . Berrangé]

On Thu, Jun 03, 2021 at 09:45:43AM +0100, Stefan Hajnoczi wrote:
> On Wed, Jun 02, 2021 at 08:11:28PM -0400, John Snow wrote:
> > Based loosely on libvirt's template, written by Peter Krempa.
> > 
> > CC: Peter Krempa <pkrempa@redhat.com>
> > Signed-off-by: John Snow <jsnow@redhat.com>
> > ---
> >  .gitlab/issue_templates/bug.md | 63 ++++++++++++++++++++++++++++++++++
> >  1 file changed, 63 insertions(+)
> >  create mode 100644 .gitlab/issue_templates/bug.md
> > 
> > diff --git a/.gitlab/issue_templates/bug.md b/.gitlab/issue_templates/bug.md
> > new file mode 100644
> > index 00000000000..9445777252b
> > --- /dev/null
> > +++ b/.gitlab/issue_templates/bug.md
> > @@ -0,0 +1,63 @@
> > +<!--
> > +This is the upstream QEMU issue tracker.
> > +
> > +Before submitting a bug, please attempt to reproduce your problem using
> > +the latest development version of QEMU, built from source. See
> > +https://www.qemu.org/download/#source for instructions on how to do
> > +this.
> 
> It's likely that those unfamiliar with QEMU, especially non-developers,
> won't be able to do this:
> 
> The wording requires the reader to figure out that "latest development
> version of QEMU" is none of the big 6.0.0, 5.2.0, etc download links at
> the top of the page but the small text "The latest development happens
> on the master branch" sentence below the fold. Then they need to look
> around the page to find out how to download the master branch and build
> from source.
> 
> I suggest referring directly to the build instructions instead of
> requiring the reader to make several connections in order to do what
> we're (indirectly) asking:
> 
>   Before submitting a bug, please attempt to reproduce the problem with
>   the latest qemu.git master built from source. See the "To download and
>   build QEMU from git" section at https://www.qemu.org/download/#source
>   for instructions.

I do wonder if this will discourage people from submitting  a bug report,
if they're unable to actually do this. We have a fairly frequent stream
of users who seek help trying to build QEMU - usually they fail to even
get the right depedancies installed.

Perhaps word it so it doesn't come across as such a strict sounding
requirement ? I'm not entirely happy with the below text, but something
more forgiving like:

   If you are able to, it will facilitate QEMU bug triage if an attempt
   is made to reproduce the problem with the latest qemu.git master
   built from source. ...etc..

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