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

[John Snow]

On 5/20/21 2:34 AM, Peter Krempa wrote:
> On Wed, May 19, 2021 at 17:32:01 -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 | 52 ++++++++++++++++++++++++++++++++++
> >   1 file changed, 52 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..3f31b5e4a09
> > --- /dev/null
> > +++ b/.gitlab/issue_templates/bug.md
> > @@ -0,0 +1,52 @@
> > +<!--
> > +This is the upstream QEMU issue tracker.
> > +
> > +Before submitting a bug, please attempt to reproduce your problem using
> > +the latest development version of QEMU obtained from
> > +https://gitlab.com/qemu-project/qemu/.
> > +
> > +QEMU generally supports the last two releases advertised via
> > +https://www.qemu.org/. Problems with distro-packaged versions of QEMU
> > +older than this should be reported to the distribution instead.
> > +
> > +See https://www.qemu.org/contribute/report-a-bug/ for guidance.
> > +-->
> > +
> > +## Host environment
> > + - Operating system: <!-- Windows 10, Fedora 34, etc. -->
> > + - OS/kernel version: <!-- For POSIX hosts, use `uname -a` -->
> > + - Architecture: <!-- x86, ARM, etc. -->
> > + - QEMU flavor: <!-- qemu-system-x86_64, qemu-aarch64, qemu-img, etc. -->
> > + - QEMU version: <!-- `qemu-system-x86_64 --version` -->
>
> In the libvirt templates we've refrained from mixing lines to be filled
> by users and comments. The users might fill in the required data into
> the comment and thus it would not show up in the default view.

Hm, reasonable. I'll omit the comment brackets.

> > + - QEMU command line:
> > +   <!--
> > +   Provide the smallest (but complete) command line that reproduces the 
> > problem.
> > +   Example:
> > +       ./qemu-system-x86_64 -M q35 -m 4096 -enable-kvm -hda fedora32.qcow2
> > +   -->
>
> Same here, if the commandline is put into this example section it will
> not be visible unless editing the issue. I'd suggest a single-line
> comment including the comment tags ...
>
> > +   ```
> > +   Insert command line here.
>
> ... and put the example here to make the user edit it.

OK.

> > +   ```
> > +
> > +## Emulated/Virtualized environment
> > + - Operating system: <!-- Windows 10 21H1, Fedora 34, etc. -->
> > + - OS/kernel version: <!-- For POSIX guests, use `uname -a` -->
> > + - Architecture: <!-- x86, ARM, s390x, etc. -->
> > +
> > +
> > +## Description of problem
> > +
> > +
> > +## Steps to reproduce
> > +1.
> > +2.
> > +3.
> > +
> > +
> > +## Additional information
> > +<!-- Attach logs, stack traces, screenshots, etc. Compress the files if 
> > necessary.
> > +<!-- See https://qemu-project.gitlab.io/qemu/devel/tracing.html on how to 
> > configure additional QEMU logging. -->
> > +
> > +
> > +<!-- The line below ensures that proper tags are added to the issue. Please do 
> > not remove it. -- >
> > +/label ~"kind::Bug"
>
> Unfortunately this doesn't seem to work if the user doesn't have
> permission to tag issues, which is the default. I'm considering removing
> these in libvirt.

I was afraid of that ... that sucks :(

I guess I can leave it in and it'll still help for issues filed by 
members of the project ...

> In addition, after committing these you should consider copying this
> template into the default issue template, which is set via the
> repository settings (it needs to be copied and pasted into a textarea in
> the web) as gitlab doesn't have a possibility to pick one of the
> templates as a default.

Mentioned this in the cover letter, I wrote a small "Please choose a 
template" message instead, because I didn't want to have to keep repo 
data and web data I don't control in sync.