.gitlab/issue_templates: Move suggestions into comments
PATCH 1/1 .gitlab/issue_templates: Move suggestions into comments
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.
--- .gitlab/issue_templates/bug.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)
.gitlab/issue_templates/bug.md +8 -8
@@ -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
Signature · 1 line
2.31.1
Quoted 11 lines · Thomas Huth
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<[email protected]>--- .gitlab/issue_templates/bug.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)
r~
Quoted 8 lines · Thomas Huth
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 <[email protected]>
Signature · 1 line
Alex Bennée
Quoted 48 lines · Thomas Huth
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 <[email protected]>--- .gitlab/issue_templates/bug.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-).gitlab/issue_templates/bug.md +8
-9@@ -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 --
Quoted 2 lines
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.
Quoted 8 lines · Thomas Huth
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 <[email protected]>
Queued to testing/next, thanks.
Signature · 2 lines
Alex Bennée Virtualisation Tech Lead @ Linaro
Quoted 11 lines · Alex Bennée
Quoted 7 lines · Thomas Huth
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.
Quoted 8 lines
Quoted 1 line
Signed-off-by Thomas Huth <[email protected]>Queued to testing/next, thanks.
--
Alex Bennée
Virtualisation Tech Lead @ Linaro
Remember to update the default template in the gitlab dashboard. I don't believe I have the permission, or I'd just take care of it myself.
--js
Quoted 16 lines · John Snow
Quoted 15 lines · Alex Bennée
Quoted 8 lines · Thomas Huth
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 <[email protected]>Queued to testing/next, thanks.
Quoted 8 lines
Quoted 4 lines
--
Alex Bennée
Virtualisation Tech Lead @ LinaroRemember to update the default template in the gitlab dashboard. I don't believe I have the permission, or I'd just take care of it myself.
Should be done now.
Signature · 2 lines
Alex Bennée Virtualisation Tech Lead @ Linaro