Re: [PATCH] .gitlab/issue_templates: Move suggestions into comments

[John Snow]

On Thu, Dec 1, 2022 at 8:38 AM Thomas Huth <thuth@redhat.com> wrote:
>
> Many users forget to remove the suggestions from the bug template
> when creating a new issue. So when searching for strings like "s390x"
> or "Windows", you get a lot of unrelated issues in the results.
> Thus let's move the suggestions into HTML comments - so they will
> still show up in the markdown when editing the bug, while being
> hidden/ignored in the final text or in the search queries.
>
> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---
>  .gitlab/issue_templates/bug.md | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)
>
> diff --git a/.gitlab/issue_templates/bug.md b/.gitlab/issue_templates/bug.md
> index e910f7b1c2..53a79f5828 100644
> --- a/.gitlab/issue_templates/bug.md
> +++ b/.gitlab/issue_templates/bug.md
> @@ -18,11 +18,11 @@ https://www.qemu.org/contribute/security-process/
>  -->
>
>  ## Host environment
> - - Operating system: (Windows 10 21H1, Fedora 34, etc.)
> - - OS/kernel version: (For POSIX hosts, use `uname -a`)
> - - Architecture: (x86, ARM, s390x, etc.)
> - - QEMU flavor: (qemu-system-x86_64, qemu-aarch64, qemu-img, etc.)
> - - QEMU version: (e.g. `qemu-system-x86_64 --version`)
> + - Operating system:            <!-- Windows 10 21H1, Fedora 37, etc. -->
> + - OS/kernel version:           <!-- For POSIX hosts, use `uname -a` -->
> + - Architecture:                <!-- x86, ARM, s390x, etc. -->
> + - QEMU flavor:                 <!-- qemu-system-x86_64, qemu-aarch64, 
> qemu-img, etc. -->
> + - QEMU version:                <!-- e.g. `qemu-system-x86_64 --version` -->
>   - QEMU command line:
>     <!--
>     Give the smallest, complete command line that exhibits the problem.
> @@ -35,9 +35,9 @@ https://www.qemu.org/contribute/security-process/
>     ```
>
>  ## 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.)
> + - Operating system:            <!-- Windows 10 21H1, Fedora 37, etc. -->
> + - OS/kernel version:           <!-- For POSIX guests, use `uname -a`. -->
> + - Architecture:                <!-- x86, ARM, s390x, etc. -->
>
>
>  ## Description of problem
> --
> 2.31.1
>

LGTM. I believe the only reason we didn't do this initially was
because the libvirt folks warned that some users might try to fill in
the comments and won't delete them. Fair enough, but I guess we can
fix that if it happens. Using the comments will do less harm overall
for poor submissions.

Don't forget to change the template from the gitlab dashboard, too:
the default bug template is not controlled by the entries in the git
repository, and you'll need to copy this over manually, IIRC.

Reviewed-by: John Snow <jsnow@redhat.com>