From 557027b8f44d856c8f187710b94ae42012412e24 Mon Sep 17 00:00:00 2001 From: Sandino Scheidegger Date: Sat, 9 Nov 2024 18:25:14 +0100 Subject: [PATCH] General: Updating GitHub Issue Templates (#936) * Clean up issue templates and include 'type' of issue for a better overview * Prettified Code! --------- Co-authored-by: ssandino --- .../admin_tool_bug_issue_template.yml | 16 +-- .../admin_tool_feature_request_template.yml | 16 +-- .../mobile_app_bug_issue_template.yml | 16 +-- .../mobile_app_feature_request_template.yml | 14 +-- .../ISSUE_TEMPLATE/ui_bug_issue_template.yml | 97 ------------------- .../ui_feature_request_template.yml | 47 --------- .../website_bug_issue_template.yml | 16 +-- .../website_feature_request_template.yml | 16 +-- 8 files changed, 29 insertions(+), 209 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/ui_bug_issue_template.yml delete mode 100644 .github/ISSUE_TEMPLATE/ui_feature_request_template.yml diff --git a/.github/ISSUE_TEMPLATE/admin_tool_bug_issue_template.yml b/.github/ISSUE_TEMPLATE/admin_tool_bug_issue_template.yml index 53500e14d..94a1d2128 100644 --- a/.github/ISSUE_TEMPLATE/admin_tool_bug_issue_template.yml +++ b/.github/ISSUE_TEMPLATE/admin_tool_bug_issue_template.yml @@ -1,19 +1,13 @@ -name: "🐞 Bug Report: Admin Tool" +name: "Admin Tool: 🐞 Bug Report" description: Create a report to help us improve the admin tool -title: "[Admin Tool]: " -labels: bug, admintool +title: "[Admin]: <title>" +labels: ["admin"] +type: "bug" body: - type: markdown attributes: value: | - # Thank you for taking the time to help us improve the app! - - type: checkboxes - attributes: - label: Is there an existing issue for this? - description: Please search to see if an issue already exists for the bug you encountered. - options: - - label: I have searched the existing issues - required: true + # Improving Social Income - type: textarea attributes: label: Describe the bug diff --git a/.github/ISSUE_TEMPLATE/admin_tool_feature_request_template.yml b/.github/ISSUE_TEMPLATE/admin_tool_feature_request_template.yml index 81478faf4..d960487ec 100644 --- a/.github/ISSUE_TEMPLATE/admin_tool_feature_request_template.yml +++ b/.github/ISSUE_TEMPLATE/admin_tool_feature_request_template.yml @@ -1,19 +1,13 @@ -name: "✨ Feature Request: Admin Tool" +name: "Admin Tool: ✨ Feature Request" description: Suggest a feature for the admin tool -title: "[Admin Tool Feature]: <title>" -labels: admintool, feature +title: "[Admin]: <title>" +labels: ["admin"] +type: "enhancement" body: - type: markdown attributes: value: | - # Thank you for taking the time to help us improve the app! - - type: checkboxes - attributes: - label: Is there an existing request for this feature? - description: Please search to see if a request already exists for the feature you'd like. - options: - - label: I have searched the existing issues - required: true + # Improving Social Income - type: textarea attributes: label: Is your feature request related to a problem? Please describe. diff --git a/.github/ISSUE_TEMPLATE/mobile_app_bug_issue_template.yml b/.github/ISSUE_TEMPLATE/mobile_app_bug_issue_template.yml index 9f37400c5..584e6ae84 100644 --- a/.github/ISSUE_TEMPLATE/mobile_app_bug_issue_template.yml +++ b/.github/ISSUE_TEMPLATE/mobile_app_bug_issue_template.yml @@ -1,19 +1,13 @@ -name: "🐞 Bug Report: Mobile App" +name: "Mobile App: 🐞 Bug Report" description: Create a report to help us improve the mobile app -title: "[Mobile App Bug]: <title>" -labels: bug, flutter, mobileapp +title: "[Mobile]: <title>" +labels: ["mobile"] +type: "bug" body: - type: markdown attributes: value: | - # Thank you for taking the time to help us improve the app! - - type: checkboxes - attributes: - label: Is there an existing issue for this? - description: Please search to see if an issue already exists for the bug you encountered. - options: - - label: I have searched the existing issues - required: true + # Improving Social Income - type: textarea attributes: label: Describe the bug diff --git a/.github/ISSUE_TEMPLATE/mobile_app_feature_request_template.yml b/.github/ISSUE_TEMPLATE/mobile_app_feature_request_template.yml index b4bca9f04..8db441430 100644 --- a/.github/ISSUE_TEMPLATE/mobile_app_feature_request_template.yml +++ b/.github/ISSUE_TEMPLATE/mobile_app_feature_request_template.yml @@ -1,19 +1,13 @@ -name: "✨ Feature Request: Mobile App" +name: "Mobile App: ✨ Feature Request" description: Suggest a feature for the mobile app title: "[Mobile App Feature]: <title>" -labels: feature, flutter, mobileapp +labels: ["mobile"] +type: "enhancement" body: - type: markdown attributes: value: | - # Thank you for taking the time to help us improve the app! - - type: checkboxes - attributes: - label: Is there an existing request for this feature? - description: Please search to see if a request already exists for the feature you'd like. - options: - - label: I have searched the existing issues - required: true + # Improving Social Income - type: textarea attributes: label: Is your feature request related to a problem? Please describe. diff --git a/.github/ISSUE_TEMPLATE/ui_bug_issue_template.yml b/.github/ISSUE_TEMPLATE/ui_bug_issue_template.yml deleted file mode 100644 index 7ddca0faf..000000000 --- a/.github/ISSUE_TEMPLATE/ui_bug_issue_template.yml +++ /dev/null @@ -1,97 +0,0 @@ -name: "🐞 Bug Report: UI library/Design System" -description: Create a report to help us improve our design system or UI library -title: "[UI / Design Bug]: <title>" -labels: bug, ui -body: - - type: markdown - attributes: - value: | - # Thank you for taking the time to help us improve the app! - - type: checkboxes - attributes: - label: Is there an existing issue for this? - description: Please search to see if an issue already exists for the bug you encountered. - options: - - label: I have searched the existing issues - required: true - - type: textarea - attributes: - label: Describe the bug - description: A clear and concise description of what the bug is. - validations: - required: false - - type: textarea - attributes: - label: Steps To Reproduce - description: Steps to reproduce the behavior. - placeholder: | - 1. Go to https://socialincome-san.github.io/public/ - 2. Click on '....' - 3. Scroll down to '....' - 4. See error - validations: - required: false - - type: textarea - attributes: - label: Expected Behavior - description: A concise description of what you expected to happen. - validations: - required: false - - type: textarea - attributes: - label: Screenshots? - description: | - If applicable, add screenshots to help explain your problem. - - Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. - validations: - required: false - - type: textarea - attributes: - label: Desktop Environment (please complete the following information) - description: | - examples: - - **OS**: Windows 11 - - **Browser**: Chrome - - **Version**: 110.111.12.12 - value: | - - OS: - - Browser: - - Version: - render: markdown - validations: - required: false - - type: textarea - attributes: - label: Smartphone Type (please complete the following information) - description: | - examples: - - **Device**: iPhone 11 - - **OS**: iOS 13.1 - - **Browser**: Safari - - **Version**: 22 - value: | - - Device: - - OS: - - Browser: - - Version: - render: markdown - validations: - required: false - - type: textarea - attributes: - label: Additional context - description: | - Links? References? Anything that will give us more context about the issue you are encountering! - - Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. - validations: - required: false - - type: checkboxes - id: terms - attributes: - label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/socialincome-san/public/blob/main/CODE_OF_CONDUCT.md) - options: - - label: I've read the Code of Conduct and understand my responsibilities as a member of the Social Income community - required: true diff --git a/.github/ISSUE_TEMPLATE/ui_feature_request_template.yml b/.github/ISSUE_TEMPLATE/ui_feature_request_template.yml deleted file mode 100644 index 029c66a72..000000000 --- a/.github/ISSUE_TEMPLATE/ui_feature_request_template.yml +++ /dev/null @@ -1,47 +0,0 @@ -name: "✨ Feature Request: UI Library/Design System" -description: Suggest a feature for the UI library or design system in general -title: "[UI / Design Feature]: <title>" -labels: feature, ui -body: - - type: markdown - attributes: - value: | - # Thank you for taking the time to help us improve the app! - - type: checkboxes - attributes: - label: Is there an existing request for this feature? - description: Please search to see if a request already exists for the feature you'd like. - options: - - label: I have searched the existing issues - required: true - - type: textarea - attributes: - label: What kind of UI element or design specification is missing from the design system? Please describe. - description: ell us what you want to build. - placeholder: | - We need a login button... - validations: - required: false - - type: textarea - attributes: - label: What other solutions have you already considered to use - description: Any elements you could use as an alternative or third-party specifications you usually use for this kind of job. - validations: - required: false - - type: textarea - attributes: - label: Anything else? - description: | - Links? References? Anything that will give us more context about the feature you are requesting - propose your solutions here! - - Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. - validations: - required: false - - type: checkboxes - id: terms - attributes: - label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/socialincome-san/public/blob/main/CODE_OF_CONDUCT.md) - options: - - label: I've read the Code of Conduct and understand my responsibilities as a member of the Social Income community - required: true diff --git a/.github/ISSUE_TEMPLATE/website_bug_issue_template.yml b/.github/ISSUE_TEMPLATE/website_bug_issue_template.yml index 79b8e5daa..1122c10b1 100644 --- a/.github/ISSUE_TEMPLATE/website_bug_issue_template.yml +++ b/.github/ISSUE_TEMPLATE/website_bug_issue_template.yml @@ -1,19 +1,13 @@ -name: "🐞 Bug Report: Website" +name: "Website: 🐞 Bug Report" description: Create a report to help us improve the website -title: "[Website Bug]: <title>" -labels: bug, website +title: "[Web]: <title>" +labels: ["website"] +type: "bug" body: - type: markdown attributes: value: | - # Thank you for taking the time to help us improve the app! - - type: checkboxes - attributes: - label: Is there an existing issue for this? - description: Please search to see if an issue already exists for the bug you encountered. - options: - - label: I have searched the existing issues - required: true + # Improving Social Income - type: textarea attributes: label: Describe the bug diff --git a/.github/ISSUE_TEMPLATE/website_feature_request_template.yml b/.github/ISSUE_TEMPLATE/website_feature_request_template.yml index 1ba13b222..26d5099f4 100644 --- a/.github/ISSUE_TEMPLATE/website_feature_request_template.yml +++ b/.github/ISSUE_TEMPLATE/website_feature_request_template.yml @@ -1,19 +1,13 @@ -name: "✨ Feature Request: Website" +name: "Website: ✨Feature Request" description: Suggest a feature for the website -title: "[Website Feature]: <title>" -labels: feature, website +title: "[Web]: <title>" +labels: ["website"] +type: "enhancement" body: - type: markdown attributes: value: | - # Thank you for taking the time to help us improve the app! - - type: checkboxes - attributes: - label: Is there an existing request for this feature? - description: Please search to see if a request already exists for the feature you'd like. - options: - - label: I have searched the existing issues - required: true + # Improving Social Income - type: textarea attributes: label: Is your feature request related to a problem? Please describe.