[PATCH 1/3] gitlab: Add issue template for reporting a generic bug

Peter Krempa pkrempa at redhat.com
Thu Nov 26 13:23:18 UTC 2020


When reporting an issue in gitlab, the project can define a template for
various scenarios which are meant to guide the users to add the relevant
information the project needs to the reported issue.

Add a template for a generic bug report against libvirt. The template
adds sections which motivate users to add version information and also
link to documentation about fetching logs and such.

Another section then motivates the users to describe the steps taken and
also the expected outcome if it's not obvious.

Finally a template also automatically applies one or more labels, so new
issues are already partially pre-triaged.

Note that markdown seems to be the only supported format for now.

Signed-off-by: Peter Krempa <pkrempa at redhat.com>
---
 .gitlab/issue_templates/bug.md | 55 ++++++++++++++++++++++++++++++++++
 1 file changed, 55 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 0000000000..f8f8ce2cef
--- /dev/null
+++ b/.gitlab/issue_templates/bug.md
@@ -0,0 +1,55 @@
+<!-- This issue describes a bug in libvirt -->
+
+<!--
+  Note: Sections like this one will be stripped out once you submit the issue.
+
+  Please describe the bug as much as possible and add any relevant information
+  you have. It allows us to deal with issues quicker.
+
+  A good bug report requires attaching of debug logs in a vast majority of cases,
+  please refer to [https://www.libvirt.org/kbase/debuglogs.html] for documentation
+  on how to obtain them.
+
+  Refer to [https://libvirt.org/bugs.html#quality] for further information regarding
+  reporting a bug.
+-->
+
+## Versions and environment
+<!--
+  Provide versions of libvirtd and possibly other relevant components if you
+  are able to narrow down the problem. Also describe any specialties in your setup.
+
+  Important:
+    Please make sure that the bug you are reporting can be reproduced with a
+    recent libvirt version (ideally upstream) to ensure that it wasn't fixed
+    already.
+-->
+ - libvirt:
+ -
+
+## Description of the bug
+<!-- Describe what happened and what's supposed to happen if that isn't obvious  -->
+
+## Steps to reproduce the bug
+<!-- Describe the steps necessary to reproduce the bug -->
+1.
+2.
+3.
+4.
+
+## Additional information
+<!--
+  Attach any relevant information:
+  - XML configuration documents of VMs or other objects
+  - log files (please attach compressed archive if you can't find the relevant section)
+
+  If reporting a crash:
+  - stack trace of the crashed binary
+
+  Please don't post screenshots of text.
+-->
+
+
+
+<!-- The line below ensures that proper tags are added to the issue. -- >
+/label ~bug
-- 
2.28.0




More information about the libvir-list mailing list