[FEATURE] New fancy yml issue templates (#369)

This commit is contained in:
Pedro Burgos 2021-12-09 21:31:56 +01:00 committed by GitHub
parent fc06db0704
commit 5e5692742e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 91 additions and 66 deletions

View file

@ -1,26 +0,0 @@
---
name: Bug report
about: Report a bug you have encountered
title: "[BUG] "
labels: bug
assignees: ''
---
## Checklist before submitting an issue
- [ ] I have searched through the existing [closed and open issues](https://github.com/elkowar/eww/issues?q=is%3Aissue) for eww and made sure this is not a duplicate
- [ ] I have specifically verified that this bug is not a common [user error](https://github.com/elkowar/eww/issues?q=is%3Aissue+label%3Ano-actual-bug+is%3Aclosed)
- [ ] I am providing as much relevant information as I am able to in this bug report (Minimal config to reproduce the issue for example, if applicable)
## Describe the bug
A clear and concise description of what the bug is.
## Reproducing the issue
Please provide a clear and and minimal description of how to reproduce the bug.
If possible, provide a simple example configuration that shows the issue.
## Expected behaviour
A clear and concise description of what you expected to happen.
## Additional context
If applicable, provide additional context or screenshots here

39
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View file

@ -0,0 +1,39 @@
name: Bug report
description: Report a bug you have encountered
title: "[BUG] "
labels: bug
body:
- type: checkboxes
attributes:
label: Checklist before submitting an issue
options:
- label: I have searched through the existing [closed and open issues](https://github.com/elkowar/eww/issues?q=is%3Aissue) for eww and made sure this is not a duplicate
required: true
- label: I have specifically verified that this bug is not a common [user error](https://github.com/elkowar/eww/issues?q=is%3Aissue+label%3Ano-actual-bug+is%3Aclosed)
required: true
- label: I am providing as much relevant information as I am able to in this bug report (Minimal config to reproduce the issue for example, if applicable)
required: true
- type: textarea
attributes:
label: "Description of the bug"
description: "A clear an concise description of what the bug is."
validations:
required: true
- type: textarea
attributes:
label: "Reproducing the issue"
description: "Please provide a clear and and minimal description of how to reproduce the bug. If possible, provide a simple example configuration that shows the issue."
validations:
required: false
- type: textarea
attributes:
label: "Expected behaviour"
description: "A clear and concise description of what you expected to happen."
validations:
required: false
- type: textarea
attributes:
label: "Additional context"
description: "If applicable, provide additional context or screenshots here."
validations:
required: false

View file

@ -1,17 +0,0 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[FEATURE] "
labels: enhancement
assignees: ''
---
## Description of the requested feature
Give a clear and concise description of the feature you are proposing, including examples for when it would be useful.
## Proposed configuration syntax
If the feature you are requesting would add or change something to the Eww configuration, please provide an example for how the feature could be used.
# Additional context
Add any other context or screenshots about the feature request here.

View file

@ -0,0 +1,23 @@
name: Feature request
description: Suggest an idea for this project
title: "[FEATURE] "
labels: [enhancement]
body:
- type: textarea
attributes:
label: "Description of the requested feature"
description: "Give a clear and concise description of the feature you are proposing, including examples for when it would be useful."
validations:
required: true
- type: textarea
attributes:
label: "Proposed configuration syntax"
description: "If the feature you are requesting would add or change something to the Eww configuration, please provide an example for how the feature could be used."
validations:
required: false
- type: textarea
attributes:
label: "Additional context"
description: "If applicable, provide additional context or screenshots here."
validations:
required: false

View file

@ -1,23 +0,0 @@
---
name: Widget request
about: Request a new Widget
title: "[WIDGET] "
labels: widget-request
assignees: ''
---
## Description of the widget
Provide an explanation of the widget.
## Implementation proposal
If applicable, describe which GTK-widgets this widget would be based on. A gallery of GTK widgets can be found [here](https://developer.gnome.org/gtk3/stable/ch03.html).
Please include links to the respective GTK documentation pages.
## Example usage
Provide an example snippet of configuration showcasing how the widget could be used, including the attributes the widget should support.
For anything non-obvious, include an explanation of how the properties should behave.
## Additional Context
Provide any additional context if applicable.

View file

@ -0,0 +1,29 @@
name: Widget request
description: Suggest an new Widget
title: "[WIDGET] "
labels: [widget-request]
body:
- type: textarea
attributes:
label: "Description of the widget"
description: "Provide an explanation of the widget."
validations:
required: true
- type: textarea
attributes:
label: "Implementation proposal"
description: "If applicable, describe which GTK-widgets this widget would be based on. A gallery of GTK widgets can be found at https://docs.gtk.org/gtk3. Please include links to the respective GTK documentation pages."
validations:
required: false
- type: textarea
attributes:
label: "Example usage"
description: "Provide an example snippet of configuration showcasing how the widget could be used, including the attributes the widget should support. For anything non-obvious, include an explanation of how the properties should behave."
validations:
required: false
- type: textarea
attributes:
label: "Additional context"
description: "Provide any additional context if applicable."
validations:
required: false