[PATCH 0/3] gitlab: Add issue templates

[Daniel P. Berrangé]

On Fri, Nov 27, 2020 at 04:15:44PM +0100, Peter Krempa wrote:
> On Thu, Nov 26, 2020 at 19:51:53 +0000, Daniel Berrange wrote:
> > On Thu, Nov 26, 2020 at 02:23:17PM +0100, Peter Krempa wrote:
> > > Gitlab allows projects to define templates for filing issues [1].
> > > Libvirt didn't have them yet. We can use them to encourage users to
> > > file better bug reports and feature requests.
> > > 
> > > You can test-drive the proposed templates in my test repo:
> > > 
> > > https://gitlab.com/pipo.sk/test/-/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=
> > > 
> > > Any suggestions on how to improve them further are very welcome.
> > 
> > Looking at it live, I get a bit lost about where exactly I need
> > to enter the information, as the huge comments dominate the view
> > compared to the prompts for information. I worry that people will
> > enter information inside the comments, which then gets thrown away.
> 
> It's not completely thrown away. If you edit the bug description, you
> still see the full source which was submitted.
> 
> Also the very first line mentions that the comments are not shown ...
> 
> > I wonder if we're better off just having the headings/prompts
> > and linking to an external page with verbose suggestions.
> 
> ... so if the user doesn't bother to read that, I doubt a link to full
> description will help.
> 
> I can try to send a cut-down version, which will have only single-line
> comments with the suggestions, but I still think that we are better off
> having the request for data in the body of the bugreport than sending
> them to some documentation elsewhere.

I pushed an example of a simpler template that is much more like the
view you get when using Bugzilla:

https://gitlab.com/berrange/libvirt/-/issues/new

https://gitlab.com/berrange/libvirt/-/commit/faf1aee60675604a04cbe2e2441dcad233963b86

IMHO, this kind of simpler template is less intimidating and clearer
as to what information to provide.

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