Gitlab: Add issue templates
v4 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
(It's outdated a bit for V4, but you get the idea.)
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.
V4:
- Change the "build on master" to be more of a nudge than a mandate, with improved instructions (stefanha, danpb)
V3:
- Add pointer to https://www.qemu.org/download/#source
- Add pointer to https://www.qemu.org/contribute/security-process/
- Remove blurb covering tracing instructions.
V2:
- Updated both templates based on feedback from Peter, Daniel, and Thomas.
John Snow (2):
GitLab: Add "Bug" issue reporting template
GitLab: Add "Feature Request" issue template.
.gitlab/issue_templates/bug.md | 64 ++++++++++++++++++++++ .gitlab/issue_templates/feature_request.md | 32 +++++++++++ 2 files changed, 96 insertions(+) create mode 100644 .gitlab/issue_templates/bug.md create mode 100644 .gitlab/issue_templates/feature_request.md
Signature · 1 line
2.31.1
PATCH v4 1/2 GitLab: Add "Bug" issue reporting template
Based loosely on libvirt's template, written by Peter Krempa.
--- .gitlab/issue_templates/bug.md | 64 ++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 .gitlab/issue_templates/bug.md
.gitlab/issue_templates/bug.md new file +64 -0
@@ -0,0 +1,64 @@ +<!-- +This is the upstream QEMU issue tracker. + +If you are able to, it will greatly facilitate bug triage if you attempt +to reproduce the problem with the latest qemu.git master built from +source. See https://www.qemu.org/download/#source for instructions on +how to do this. + +QEMU generally supports the last two releases advertised on +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 additional +guidance. + +If this is a security issue, please consult +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`) + - QEMU command line: + <!-- + Give the smallest, complete command line that exhibits the problem. + + If you are using libvirt, virsh, or vmm, you can likely find the QEMU + command line arguments in /var/log/libvirt/qemu/$GUEST.log. + --> + ``` + ./qemu-system-x86_64 -M q35 -m 4096 -enable-kvm -hda fedora32.qcow2 + ``` + +## 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 +<!-- Describe the problem, including any error/crash messages seen. --> + + +## Steps to reproduce +1. +2. +3. + + +## Additional information + +<!-- +Attach logs, stack traces, screenshots, etc. Compress the files if necessary. +If using libvirt, libvirt logs and XML domain information may be relevant. +--> + +<!-- +The line below ensures that proper tags are added to the issue. +Please do not remove it. +--> +/label ~"kind::Bug"
Signature · 1 line
2.31.1
Re: [PATCH v4 1/2] GitLab: Add "Bug" issue reporting template
Quoted 4 lines · John Snow
Based loosely on libvirt's template, written by Peter Krempa.
CC Peter Krempa <[email protected]>Signed-off-by John Snow <[email protected]>
LGTM:
Signature · 1 line
Alex Bennée
PATCH v4 2/2 GitLab: Add "Feature Request" issue template.
In reply to John SnowBased on Peter Krempa's libvirt template, feature.md.
--- .gitlab/issue_templates/feature_request.md | 32 ++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .gitlab/issue_templates/feature_request.md
.gitlab/issue_templates/feature_request.md new file +32 -0
@@ -0,0 +1,32 @@ +<!-- +This is the upstream QEMU issue tracker. + +Please note that QEMU, like most open source projects, relies on +contributors who have motivation, skills and available time to work on +implementing particular features. + +Feature requests can be helpful for determining demand and interest, but +they are not a guarantee that a contributor will volunteer to implement +it. We welcome and encourage even draft patches to implement a feature +be sent to the mailing list where it can be discussed and developed +further by the community. + +Thank you for your interest in helping us to make QEMU better! +--> + +## 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.31.1
Re: [PATCH v4 2/2] GitLab: Add "Feature Request" issue template.
Quoted 32 lines · John Snow
Based on Peter Krempa's libvirt template, feature.md.
CC Peter Krempa <[email protected]>Signed-off-by John Snow <[email protected]>Reviewed-by Stefan Hajnoczi <[email protected]>Reviewed-by Thomas Huth <[email protected]>--- .gitlab/issue_templates/feature_request.md | 32 ++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .gitlab/issue_templates/feature_request.md.gitlab/issue_templates/feature_request.md new file +15
-0@@ -0,0 +1,32 @@ +<!-- +This is the upstream QEMU issue tracker. + +Please note that QEMU, like most open source projects, relies on +contributors who have motivation, skills and available time to work on +implementing particular features. + +Feature requests can be helpful for determining demand and interest, but +they are not a guarantee that a contributor will volunteer to implement +it. We welcome and encourage even draft patches to implement a feature +be sent to the mailing list where it can be discussed and developed +further by the community. + +Thank you for your interest in helping us to make QEMU better! +-->
.gitlab/issue_templates/feature_request.md line 25
Quoted 10 lines
.gitlab/issue_templates/feature_request.md new file +10
-0+ +## Goal +<!-- Describe the final result you want to achieve. Avoid design specifics. --> + + +## Technical details +<!-- Describe technical details, design specifics, suggestions, versions, etc. --> + + +## Additional information
<!-- Patch or branch references, any other useful information -->?
Either way:
Quoted 7 lines
.gitlab/issue_templates/feature_request.md new file +7
-0+ + +<!-- +The line below ensures that proper tags are added to the issue. +Please do not remove it. +--> +/label ~"kind::Feature Request"
Signature · 1 line
Alex Bennée
Re: [PATCH v4 2/2] GitLab: Add "Feature Request" issue template.
Quoted 7 lines · Alex Bennée
<!-- Patch or branch references, any other useful information -->?
Either way:
Reviewed-by Alex Bennée<[email protected]>
Thanks. I'm not sure who will merge this -- It might even reasonably fall under your jurisdiction. You could squash this in if none of the other reviewers object to it.
--js
Quoted 41 lines · John Snow
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
(It's outdated a bit for V4, but you get the idea.)
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.
V4:
- Change the "build on master" to be more of a nudge than a mandate, with improved instructions (stefanha, danpb)V3:
- Add pointer to https://www.qemu.org/download/#source
- Add pointer to https://www.qemu.org/contribute/security-process/
- Remove blurb covering tracing instructions.V2:
- Updated both templates based on feedback from Peter, Daniel, and Thomas.John Snow (2):
GitLab: Add "Bug" issue reporting template
GitLab: Add "Feature Request" issue template.
Quoted 10 lines
.gitlab/issue_templates/bug.md | 64 ++++++++++++++++++++++ .gitlab/issue_templates/feature_request.md | 32 +++++++++++ 2 files changed, 96 insertions(+) create mode 100644 .gitlab/issue_templates/bug.md create mode 100644 .gitlab/issue_templates/feature_request.mdSignature · 1 line
2.31.1
Quoted 41 lines · John Snow
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
(It's outdated a bit for V4, but you get the idea.)
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.
V4:
- Change the "build on master" to be more of a nudge than a mandate, with improved instructions (stefanha, danpb)V3:
- Add pointer to https://www.qemu.org/download/#source
- Add pointer to https://www.qemu.org/contribute/security-process/
- Remove blurb covering tracing instructions.V2:
- Updated both templates based on feedback from Peter, Daniel, and Thomas.John Snow (2):
GitLab: Add "Bug" issue reporting template
GitLab: Add "Feature Request" issue template.
Quoted 6 lines
.gitlab/issue_templates/bug.md | 64 ++++++++++++++++++++++ .gitlab/issue_templates/feature_request.md | 32 +++++++++++ 2 files changed, 96 insertions(+)create mode 100644
.gitlab/issue_templates/bug.mdcreate mode 100644.gitlab/issue_templates/feature_request.md
Gentle ping. I do not know whose jurisdiction this falls under.
--js
Quoted 42 lines · John Snow
Quoted 41 lines · John Snow
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
(It's outdated a bit for V4, but you get the idea.)
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.
V4:
- Change the "build on master" to be more of a nudge than a mandate, with improved instructions (stefanha, danpb)V3:
- Add pointer to https://www.qemu.org/download/#source
- Add pointer to https://www.qemu.org/contribute/security-process/
- Remove blurb covering tracing instructions.V2:
- Updated both templates based on feedback from Peter, Daniel, and Thomas.John Snow (2):
GitLab: Add "Bug" issue reporting template
GitLab: Add "Feature Request" issue template.
Quoted 8 lines
Quoted 6 lines
.gitlab/issue_templates/bug.md | 64 ++++++++++++++++++++++
.gitlab/issue_templates/feature_request.md| 32 +++++++++++2 files changed, 96 insertions(+)create mode 100644
.gitlab/issue_templates/bug.mdcreate mode 100644.gitlab/issue_templates/feature_request.mdGentle ping. I do not know whose jurisdiction this falls under.
I assume this should be merged by someone who has maintainer rights in the qemu-project on gitlab (for also updating the default template)?
Thomas
Alex, do you want to stage this one with your test pulls? (You could amend patch #2 with your suggestion when you do?)
Quoted 57 lines · Thomas Huth
Quoted 42 lines · John Snow
Quoted 41 lines · John Snow
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
(It's outdated a bit for V4, but you get the idea.)
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.
V4:
- Change the "build on master" to be more of a nudge than a mandate, with improved instructions (stefanha, danpb)V3:
- Add pointer to https://www.qemu.org/download/#source
- Add pointer to https://www.qemu.org/contribute/security-process/
- Remove blurb covering tracing instructions.V2:
- Updated both templates based on feedback from Peter, Daniel, and Thomas.John Snow (2):
GitLab: Add "Bug" issue reporting template
GitLab: Add "Feature Request" issue template.Quoted 8 lines
Quoted 6 lines
.gitlab/issue_templates/bug.md | 64 ++++++++++++++++++++++
.gitlab/issue_templates/feature_request.md| 32 +++++++++++2 files changed, 96 insertions(+)create mode 100644
.gitlab/issue_templates/bug.mdcreate mode 100644.gitlab/issue_templates/feature_request.mdGentle ping. I do not know whose jurisdiction this falls under.
I assume this should be merged by someone who has maintainer rights in the qemu-project on gitlab (for also updating the default template)?
Thomas
Quoted 9 lines · John Snow
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
(It's outdated a bit for V4, but you get the idea.)
Quoted 7 lines
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:
Queued to testing/next, thanks.
Signature · 1 line
Alex Bennée