[v2,0/2] Gitlab: Add issue templates

Message

John Snow May 21, 2021, 5:38 p.m. UTC

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

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             | 61 ++++++++++++++++++++++
 .gitlab/issue_templates/feature_request.md | 32 ++++++++++++
 2 files changed, 93 insertions(+)
 create mode 100644 .gitlab/issue_templates/bug.md
 create mode 100644 .gitlab/issue_templates/feature_request.md

Comments

John Snow May 27, 2021, 7:55 p.m. UTC | #1

ping -- Any objections?

On 5/21/21 1:38 PM, John Snow wrote:
> 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
> 
> 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             | 61 ++++++++++++++++++++++
>   .gitlab/issue_templates/feature_request.md | 32 ++++++++++++
>   2 files changed, 93 insertions(+)
>   create mode 100644 .gitlab/issue_templates/bug.md
>   create mode 100644 .gitlab/issue_templates/feature_request.md
>