Skip to contentSkip to conversation

Gitlab: Add issue templates

PATCH Superseded John Snow 4 participants 8 messages May 19, 2021 – May 21, 2021

v1 of 4 Superseded Latest is v4 →

lore
Share & tools
lore

John Snow

author
#0 lore raw

cover Gitlab: Add issue templates

Add "Bug" and "Feature Request" templates to the Gitlab interface to help improve the quality of newly reported issues.

To see what this looks like, I've temporarily allowed my Gitlab fork to diverge with these files merged. See my fork's "new issue" page to see it in action: https://gitlab.com/jsnow/qemu/-/issues/new?issue

These patches do not add a "default" template, the user still has to select one from the list. I recommend that someone with permissions updates the default template:

1. https://gitlab.com/qemu-project/qemu/edit
2. ctrl+f "Default description template for issues"
3. Update the default to the (suggested) below:

```
<!-- Select "Type: Issue" and choose one of the Description templates above. -->
```

We can use this cover letter to discuss/review the wording on that default template which exists outside of repository data.

--js

John Snow (2):
Gitlab: Add "Bug" issue reporting template
Gitlab: Add "Feature Request" issue template.

 .gitlab/issue_templates/bug.md             | 52 ++++++++++++++++++++++
 .gitlab/issue_templates/feature_request.md | 13 ++++++
 2 files changed, 65 insertions(+)
 create mode 100644 .gitlab/issue_templates/bug.md
 create mode 100644 .gitlab/issue_templates/feature_request.md
Signature · 1 line
2.30.2
author
#1 lore raw

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

Based loosely on libvirt's template, written by Peter Krempa.

CC Peter Krempa <[email protected]>
---
 .gitlab/issue_templates/bug.md | 52 ++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 .gitlab/issue_templates/bug.md
.gitlab/issue_templates/bug.md new file +52 -0
new file mode 100644
index 00000000000..3f31b5e4a09
@@ -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` -->
+ - 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
+   -->
+   ```
+   Insert command line here.
+   ```
+
+## 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"
Signature · 1 line
2.30.2
author
#4 lore raw

PATCH 2/2 Gitlab: Add "Feature Request" issue template.

In reply to John Snow

Copied from Peter Krempa's libvirt template, feature.md.

CC Peter Krempa <[email protected]>
---
 .gitlab/issue_templates/feature_request.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 .gitlab/issue_templates/feature_request.md
.gitlab/issue_templates/feature_request.md new file +13 -0
new file mode 100644
index 00000000000..26901ff00c4
@@ -0,0 +1,13 @@
+## Goal
+<!-- Describe the final result you want to achieve. Avoid design specifics. -->
+
+
+## Technical details
+<!-- Describe technical details, design specifics, suggestions, versions, etc. -->
+
+
+## Additional information
+
+
+<!-- The line below ensures that proper tags are added to the issue. Please do not remove it. -- >
+/label ~"kind::Feature Request"
Signature · 1 line
2.30.2
#2 lore raw

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

In reply to John Snow
Quoted 25 lines · John Snow

Based loosely on libvirt's template, written by Peter Krempa.

CC Peter Krempa <[email protected]>
---
 .gitlab/issue_templates/bug.md | 52 ++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 .gitlab/issue_templates/bug.md
.gitlab/issue_templates/bug.md new file +10 -0
new file mode 100644
index 00000000000..3f31b5e4a09
@@ -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.

.gitlab/issue_templates/bug.md line 20

Quoted 10 lines
.gitlab/issue_templates/bug.md new file +10 -0
+
+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.

.gitlab/issue_templates/bug.md line 26

Quoted 6 lines
.gitlab/issue_templates/bug.md new file +6 -0
+ - 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 ...

.gitlab/issue_templates/bug.md line 28

Quoted 2 lines
.gitlab/issue_templates/bug.md new file +2 -0
+   ```
+   Insert command line here.

... and put the example here to make the user edit it.

Quoted 14 lines
.gitlab/issue_templates/bug.md new file +14 -0
+   ```
+
+## 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.

.gitlab/issue_templates/bug.md line 52

Quoted 10 lines
.gitlab/issue_templates/bug.md new file +10 -0
+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.

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.

#5 lore raw

Re: [PATCH 2/2] Gitlab: Add "Feature Request" issue template.

In reply to John Snow
Quoted 15 lines · John Snow

Copied from Peter Krempa's libvirt template, feature.md.

CC Peter Krempa <[email protected]>
---
  .gitlab/issue_templates/feature_request.md | 13 +++++++++++++
  1 file changed, 13 insertions(+)

create mode 100644 .gitlab/issue_templates/feature_request.md

.gitlab/issue_templates/feature_request.md new file +0 -0
new file mode 100644
index 00000000000..26901ff00c4

.gitlab/issue_templates/feature_request.md line 2

Quoted 2 lines
.gitlab/issue_templates/feature_request.md new file +2 -0
@@ -0,0 +1,13 @@
+## Goal
+<!-- Describe the final result you want to achieve. Avoid design specifics. -->

Since some people apparently had wrong expectations when filing a feature request in the past, it might be good to add some words about what to expect. Maybe something like this (re-using some wording that Daniel already added to some tickets in the past IIRC):

Please note that the QEMU, like most open source projects, relies on
contributors who have motivation, skills and available time to work on implementing particular features. Contributors naturally tend to focus on features that result in the greatest benefit to their own use cases. Thus the QEMU project doesn't implement new big features (like target architectures or board models) on demand based on feature requests here; they're a lot of work to do. Instead we simply code-review and incorporate new big features as and when people decide to write them and submit the patches. So please only submit small requests here. Thanks!

?

Thomas

author
#3 lore raw

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

In reply to Peter Krempa
Quoted 32 lines · Peter Krempa
Quoted 31 lines · John Snow

Based loosely on libvirt's template, written by Peter Krempa.

CC Peter Krempa <[email protected]>
---
  .gitlab/issue_templates/bug.md | 52 ++++++++++++++++++++++++++++++++++
  1 file changed, 52 insertions(+)

create mode 100644 .gitlab/issue_templates/bug.md

.gitlab/issue_templates/bug.md new file +16 -0
new file mode 100644
index 00000000000..3f31b5e4a09
@@ -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. -->
Quoted 9 lines

.gitlab/issue_templates/bug.md line 20

Quoted 4 lines
.gitlab/issue_templates/bug.md new file +4 -0
+ - 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.

Quoted 8 lines

.gitlab/issue_templates/bug.md line 26

Quoted 7 lines
.gitlab/issue_templates/bug.md new file +6 -0
+ - 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
+   -->
Quoted 9 lines

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

.gitlab/issue_templates/bug.md line 28

Quoted 2 lines
.gitlab/issue_templates/bug.md new file +2 -0
+   ```
+   Insert command line here.

... and put the example here to make the user edit it.

OK.

Quoted 20 lines
Quoted 20 lines
.gitlab/issue_templates/bug.md new file +20 -0
+   ```
+
+## 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. -->
Quoted 9 lines

.gitlab/issue_templates/bug.md line 52

Quoted 4 lines
.gitlab/issue_templates/bug.md new file +4 -0
+
+
+<!-- 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 ...

Quoted 6 lines

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.

author
#6 lore raw

Re: [PATCH 2/2] Gitlab: Add "Feature Request" issue template.

In reply to Thomas Huth
Quoted 22 lines · Thomas Huth
Quoted 17 lines · John Snow

Copied from Peter Krempa's libvirt template, feature.md.

CC Peter Krempa <[email protected]>

---
  .gitlab/issue_templates/feature_request.md | 13 +++++++++++++

  1 file changed, 13 insertions(+)

  create mode 100644 .gitlab/issue_templates/feature_request.md

.gitlab/issue_templates/feature_request.md new file +2 -0
new file mode 100644
index 00000000000..26901ff00c4
@@ -0,0 +1,13 @@
+## Goal
+<!-- Describe the final result you want to achieve. Avoid design 
Quoted 1 line

specifics. -->

Since some people apparently had wrong expectations when filing a feature request in the past, it might be good to add some words about what to expect. Maybe something like this (re-using some wording that Daniel already added to some tickets in the past IIRC):

Quoted 5 lines

 Please note that the QEMU, like most open source projects, relies on
contributors who have motivation, skills and available time to work on implementing particular features. Contributors naturally tend to focus on features that result in the greatest benefit to their own use cases. Thus the QEMU project doesn't implement new big features (like target architectures or board models) on demand based on feature requests here; they're a lot of work to do. Instead we simply code-review and incorporate new big features as and when people decide to write them and submit the patches. So please only submit small requests here. Thanks!

?

OK, I may edit it just a little bit to appear a touch softer. A concern I have is that users may not really know the difference between a 'small' and a 'big' feature, necessarily.

Still, setting an expectation might help...

--js

#7 lore raw

Re: [PATCH 2/2] Gitlab: Add "Feature Request" issue template.

Quoted 37 lines · John Snow
Quoted 36 lines · Thomas Huth
Quoted 18 lines · John Snow

Copied from Peter Krempa's libvirt template, feature.md.

CC Peter Krempa <[email protected]>

---
  .gitlab/issue_templates/feature_request.md | 13 +++++++++++++

  1 file changed, 13 insertions(+)

  create mode 100644 .gitlab/issue_templates/feature_request.md

.gitlab/issue_templates/feature_request.md new file +2 -0
new file mode 100644
index 00000000000..26901ff00c4
@@ -0,0 +1,13 @@
+## Goal
+<!-- Describe the final result you want to achieve. Avoid design
Quoted 1 line

specifics. -->

Since some people apparently had wrong expectations when filing a feature request in the past, it might be good to add some words about what to expect. Maybe something like this (re-using some wording that Daniel already added to some tickets in the past IIRC):

 Please note that the QEMU, like most open source projects, relies on
contributors who have motivation, skills and available time to work on implementing particular features. Contributors naturally tend to focus on features that result in the greatest benefit to their own use cases. Thus the QEMU project doesn't implement new big features (like target architectures or board models) on demand based on feature requests here; they're a lot of work to do. Instead we simply code-review and incorporate new big features as and when people decide to write them and submit the patches. So please only submit small requests here. Thanks!

Quoted 8 lines
Quoted 2 lines

?

OK, I may edit it just a little bit to appear a touch softer. A concern I have is that users may not really know the difference between a 'small' and a 'big' feature, necessarily.

Still, setting an expectation might help...

Yeah, I think we could be a little more positive in how we phrase it. Perhaps ust focus on what filing a feature request does achieve.

The value is primarily about illustrating & recording a use case to the project, and providing a place to discuss it and guage interest from others.

There should be no expectation that anyone will work on it, but seeing the feature request might pique someone's interest enough that they want to work on it. I think probably the big vs small distinction doesn't really matter much.

Regards,
Daniel

Signature · 3 lines
|: 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 :|