From 9f3222d9b85ce8e52dea481c682e216263cc2763 Mon Sep 17 00:00:00 2001 From: Isaac Gray-Christensen Date: Mon, 15 Jan 2024 18:45:09 -0800 Subject: [PATCH] Added issue templates to help with workflows --- .github/ISSUE_TEMPLATE/1-bug_template.yml | 87 +++++++++++++++++++ .github/ISSUE_TEMPLATE/2-feature_template.yml | 41 +++++++++ .../3-general_question_template.yml | 14 +++ .github/ISSUE_TEMPLATE/config.yml | 0 4 files changed, 142 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/1-bug_template.yml create mode 100644 .github/ISSUE_TEMPLATE/2-feature_template.yml create mode 100644 .github/ISSUE_TEMPLATE/3-general_question_template.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/1-bug_template.yml b/.github/ISSUE_TEMPLATE/1-bug_template.yml new file mode 100644 index 00000000..1a07eda7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug_template.yml @@ -0,0 +1,87 @@ +name: "🐛 Bug Report" +description: Create a new ticket for a bug. +title: "🐛 [Bug] - " +labels: [ "bug" ] + +body: + - type: markdown + attributes: + value: | + ### Expected Behavior + --- + + ### Current Behavior + --- + + ### Steps to Reproduce + --- + + Please try to describe the issue as best as possible + + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + + - type: input + id: version + attributes: + label: "FrappeBooks Version" + # description: Please enter your GitHub URL to provide a reproduction of the issue + placeholder: ex. 0.20.0 + validations: + required: true + + - type: input + id: path_feature_name + attributes: + label: "Path or Feature name" + description: Please enter the path (i.e. /import-wizard) or Feature name where the bug was seen + placeholder: ex. Import-Wizard + validations: + required: true + + - type: input + id: country_code + attributes: + label: "Country" + description: Please enter the two digit country code for your country (i.e. BR, CH, IN, US) + placeholder: ex. IN + validations: + required: true + + - type: input + id: language + attributes: + label: "Language" + description: Please enter the two digit language code or full lanaguage used in the application + placeholder: ex. EN or english + validations: + required: true + + - type: dropdown + id: os + attributes: + label: "OS" + description: What is the impacted environment ? + multiple: true + options: + - Windows 8 + - Windows 8.1 + - Windows 10 + - Windows 11 + - Linux x86_64 + - Linux Arm64 (i.e. Raspberry Pi) + - Macos (Intel) + - Macos (Apple Silicon) + validations: + required: true + + - type: input + id: additional_os_info + attributes: + label: "Additional OS Info" + description: Please enter any additional information regarding your OS that may aid in troubleshooting (i.e. Macos 10.14, Ubuntu 20.04, etc) + placeholder: ex. Macos 10.14 / Ubuntu 20.04 + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/2-feature_template.yml b/.github/ISSUE_TEMPLATE/2-feature_template.yml new file mode 100644 index 00000000..63dd73af --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature_template.yml @@ -0,0 +1,41 @@ +name: "💡 Feature Request" +description: Create a new ticket for a new feature request +title: "💡 [Feature Request] - <title>" +labels: [ "enhancement" ] + +body: + - type: textarea + id: summary + attributes: + label: "Summary" + description: Provide a brief explanation of the feature + placeholder: Describe in a few lines your feature request + validations: + required: true + + - type: textarea + id: basic_example + attributes: + label: "Basic Example" + description: Indicate here some basic examples of your feature. + placeholder: A few specific words about your feature request. + validations: + required: true + + - type: textarea + id: drawbacks + attributes: + label: "Drawbacks" + description: What are the drawbacks/impacts of your feature request ? + placeholder: Identify the drawbacks and impacts while being neutral on your feature request + validations: + required: true + + - type: textarea + id: reference_issues + attributes: + label: "Reference Issues" + description: Common issues + placeholder: "#Issues IDs" + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/3-general_question_template.yml b/.github/ISSUE_TEMPLATE/3-general_question_template.yml new file mode 100644 index 00000000..1b59a6e5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-general_question_template.yml @@ -0,0 +1,14 @@ +name: "General Question" +description: Create a new ticket for a general question +title: "🐛 [General Question] - <title>" +labels: [ "question" ] + +body: + - type: textarea + id: summary + attributes: + label: "Summary" + description: General Question(s) (for Bugs and Feature Requests, please use the appropriate template) + placeholder: "..." + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..e69de29b