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

Daniel P. Berrangé berrange at redhat.com
Tue Dec 1 09:19:20 UTC 2020


On Tue, Dec 01, 2020 at 06:52:16AM +0100, Peter Krempa wrote:
> 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 | 26 ++++++++++++++++++++++++++
>  1 file changed, 26 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..f3a9f3e722
> --- /dev/null
> +++ b/.gitlab/issue_templates/bug.md
> @@ -0,0 +1,26 @@
> +<!-- See https://libvirt.org/bugs.html#quality for guidance -->
> +
> +## Software environment
> + - Operating system:
> + - Architecture:
> + - kernel version:
> + - libvirt version:
> + - Hypervisor and version:
> +
> +## Description of problem
> +
> +## Steps to reproduce
> +1.
> +2.
> +3.
> +
> +## Expected behavior

I wonder if we need this - I've always found the expected/actual
behaviour sections in bugzilla's template redundant, as the description
should already cover it.

Regardless of answer, though it can have 

  Reviewed-by: Daniel P. Berrangé <berrange at redhat.com>


> +
> +## Additional information
> +<!-- Attach XML configs, logs, stack traces, etc. Compress the files if necessary -->
> +<!-- See https://libvirt.org/kbase/debuglogs.html on how to configure logging -->
> +
> +
> +
> +<!-- The line below ensures that proper tags are added to the issue. -- >
> +/label ~bug
> -- 
> 2.28.0
> 

Regards,
Daniel
-- 
|: 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 :|




More information about the libvir-list mailing list