From ade0da19eda2bebe950fb2d5ab3708c2d4d055d9 Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Sun, 22 Aug 2021 15:21:28 +0100 Subject: [PATCH] :octocat: Updates issue templates --- .../add-your-dashboard-to-the-showcase----.md | 20 ------ .github/ISSUE_TEMPLATE/bug.yml | 7 ++- .github/ISSUE_TEMPLATE/feature-request.md | 17 ----- .github/ISSUE_TEMPLATE/feature-request.yml | 62 +++++++++++++++++++ .github/ISSUE_TEMPLATE/showcase-addition.yml | 58 +++++++++++++++++ 5 files changed, 125 insertions(+), 39 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/add-your-dashboard-to-the-showcase----.md delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/showcase-addition.yml diff --git a/.github/ISSUE_TEMPLATE/add-your-dashboard-to-the-showcase----.md b/.github/ISSUE_TEMPLATE/add-your-dashboard-to-the-showcase----.md deleted file mode 100644 index d6cf344c..00000000 --- a/.github/ISSUE_TEMPLATE/add-your-dashboard-to-the-showcase----.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: "Add your Dashboard to the Showcase \U0001F5BC️" -about: Share a screenshot of your dashboard to the Readme showcase! -title: "[SHOWCASE_REQUEST]" -labels: '' -assignees: '' - ---- - -Please read the instructions here first: -https://github.com/Lissy93/dashy/blob/master/docs/showcase.md#submitting-your-dashboard - -### Complete the Following -- **Title of Dashboard**: -- **Link to Screenshot**: -- **Would you like your name/ username included**: Yes/ No -- **Link to your Website/ Profile/ Twitter** (optional) -- **Description** (optional) - -Either attach your screenshot here, or include a link to the CDN / image hosting service. diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 48bf3627..38486ec0 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -1,7 +1,9 @@ name: Bug Report 🐛 description: Report something that's not working the way it's (probably) intended to title: '[BUG] ' -labels: '\U0001F41B Bug' +labels: ['🐛 Bug'] +assignees: + - lissy93 body: - type: dropdown id: environment @@ -34,6 +36,7 @@ body: attributes: label: Additional info description: Logs? Screenshots? Yes, please. + placeholder: If the issue happens during build-time, include terminal logs. For run-time errors, include browser logs which you can view in the Dev Tools (F12), under the Console tab. Take care to blank out any personal info. validations: required: false - type: checkboxes @@ -42,7 +45,7 @@ body: label: Please tick the boxes description: Before submitting, please ensure that options: - - label: You are using the latest, or recent version of Dashy + - label: You are using a [supported](https://github.com/Lissy93/dashy/blob/master/.github/SECURITY.md#supported-versions) version of Dashy (check the first two digits of the version number) required: true - label: You've checked that this [issue hasn't already been raised](https://github.com/Lissy93/dashy/issues?q=is%3Aissue) required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 97e0f091..00000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: "Feature Request \U0001F984" -about: Suggest an idea for future development of Dashy -title: "[FEATURE_REQUEST]" -labels: "\U0001F984 Feature Request" -assignees: Lissy93 - ---- - -**Is your feature request related to a problem? If so, please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Priority**: -Low: Nice to have / Medium: Would be useful / High: The app does not function without it diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..f01480f2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,62 @@ +name: Bug Report 🐛 +description: Suggest an idea for future development of Dashy +title: '[FEATURE_REQUEST] <title>' +labels: ['\U0001F984 Feature Request'] + +body: + + # Field 1 - Is it bug-related + - type: textarea + id: issue + attributes: + label: Is your feature request related to a problem? If so, please describe. + description: + placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: false + + # Field 2 - Describe feature + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + placeholder: An outline of how you would like this to be implemented, include as much details as possible + validations: + required: true + + # Field 3 - Priority + - type: dropdown + id: priority + attributes: + label: Priority + description: How urgent is the development of this feature + options: + - Low (Nice-to-have) + - Medium (Would be very useful) + - High (The app does not function without it) + validations: + required: true + + # Field 3 - Can the user implement + - type: dropdown + id: canImplement + attributes: + label: Is this something you would be keen to implement + description: Are you raising this ticket in order to get an issue number for your PR? + options: + - 'No' + - 'Maybe' + - 'Yes!' + validations: + required: false + + # Final text + - type: markdown + attributes: + value: |- + ## Thanks 🙏 + Thank you for your feature suggestion, you should expect a reply within 48 hours :) + Please note that there is no guarantee that your idea will be implemented + If you haven't already done so, please Star the Dashy's repository on GitHub, to help other users discover it + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/showcase-addition.yml b/.github/ISSUE_TEMPLATE/showcase-addition.yml new file mode 100644 index 00000000..5d3b66f1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/showcase-addition.yml @@ -0,0 +1,58 @@ +name: Add your Dashboard to the Showcase 🌟 +description: Share a screenshot of your dashboard to the Readme showcase! +title: '[SHOWCASE] <title>' +labels: ['💯 Showcase'] + +body: +# 1 - Title +- type: input + id: title + attributes: + label: Title + description: Pick a title for your addition + placeholder: My Awesome Dashboard + validations: + required: false +# 2 - Link to Screenshot +- type: textarea + id: screenshot + attributes: + label: Screenshot + description: Either upload your screenshot here, or include a link to a png/jpg on a CDN / image hosting service + validations: + required: true +# 3 - Credit user +- type: dropdown + id: attribution + attributes: + label: Would you like your name/ username included? + description: This will be displayed above the screenshot to your dashboard in the showcase page + options: + - Yes + - No + validations: + required: true +# 4 - Social links +- type: input + id: links + attributes: + label: Link to your Website/ Profile/ Twitter (optional) + description: You can optionally have your name link to your profile or website. If you'd like this, include the URL to your site below + validations: + required: false +# 5 - Description +- type: textarea + id: description + attributes: + label: Description (Optional) + description: You can optionally also include a short description. If there's anything else you'd like to include, then put it here + validations: + required: false +# 6 - All done +- type: markdown + attributes: + value: |- + ## That's It! + Thanks for sharing your dashboard :) You will receive an update to this ticket once it's added to the showcase + validations: + required: false \ No newline at end of file