From 5e5692742e046a97e3da3a5e19c50c331403c115 Mon Sep 17 00:00:00 2001 From: Pedro Burgos <43417195+druskus20@users.noreply.github.com> Date: Thu, 9 Dec 2021 21:31:56 +0100 Subject: [PATCH] [FEATURE] New fancy yml issue templates (#369) --- .github/ISSUE_TEMPLATE/bug_report.md | 26 --------------- .github/ISSUE_TEMPLATE/bug_report.yml | 39 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 17 ---------- .github/ISSUE_TEMPLATE/feature_request.yml | 23 +++++++++++++ .github/ISSUE_TEMPLATE/widget-request.md | 23 ------------- .github/ISSUE_TEMPLATE/widget-request.yml | 29 ++++++++++++++++ 6 files changed, 91 insertions(+), 66 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/widget-request.md create mode 100644 .github/ISSUE_TEMPLATE/widget-request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 26d0eef..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -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 diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..275d789 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 09c9a8f..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..287db75 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/widget-request.md b/.github/ISSUE_TEMPLATE/widget-request.md deleted file mode 100644 index 7da309a..0000000 --- a/.github/ISSUE_TEMPLATE/widget-request.md +++ /dev/null @@ -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. diff --git a/.github/ISSUE_TEMPLATE/widget-request.yml b/.github/ISSUE_TEMPLATE/widget-request.yml new file mode 100644 index 0000000..7ebb425 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/widget-request.yml @@ -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