From 6e26de1cf3080db93ed892339369fb58d082ca19 Mon Sep 17 00:00:00 2001 From: Roman Grinovski Date: Wed, 20 Sep 2023 13:53:45 +0200 Subject: [PATCH] add basic issue templates (#164) * add basic issue templates * adjust wording * Update bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.yml | 72 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/improvement_idea.yml | 39 +++++++++++ 2 files changed, 111 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/improvement_idea.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..e98f7b4f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,72 @@ +name: "🐛 Bug Report" +description: Create a new ticket for a bug. +title: "🐛 [BUG] - " +labels: [ + "bug" +] +body: + - type: textarea + id: description + attributes: + label: "Description" + description: Please enter an explicit description of your issue + placeholder: Short and explicit description of your incident... + validations: + required: true + - type: textarea + id: reprod + attributes: + label: "Reproduction steps" + description: Please enter an explicit description of your issue + value: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + render: bash + validations: + required: true + - type: textarea + id: screenshot + attributes: + label: "Screenshots" + description: If applicable, add screenshots to help explain your problem. + value: | + ![DESCRIPTION](LINK.png) + render: bash + validations: + required: false + - type: textarea + id: logs + attributes: + label: "Logs" + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: bash + validations: + required: false + - type: dropdown + id: browsers + attributes: + label: "Browsers" + description: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + - Opera + validations: + required: false + - type: dropdown + id: os + attributes: + label: "OS" + description: On which operating system this issue occurs? + multiple: true + options: + - Windows + - Linux + - Mac + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/improvement_idea.yml b/.github/ISSUE_TEMPLATE/improvement_idea.yml new file mode 100644 index 00000000..c18d6290 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improvement_idea.yml @@ -0,0 +1,39 @@ +name: "💡 Improvement idea" +description: Create a new ticket for improvement +title: "💡 [IMPROVEMENT] - <title>" +labels: [ + "improvement" +] +body: + - type: textarea + id: summary + attributes: + label: "Summary" + description: Provide a brief explanation of the improvement + placeholder: Describe in a few lines your idea + validations: + required: true + - type: textarea + id: basic_example + attributes: + label: "Basic Example" + description: Indicate here some basic examples of your idea. + placeholder: A few specific words about your idea. + validations: + required: true + - type: textarea + id: drawbacks + attributes: + label: "Drawbacks" + description: What are the drawbacks/impacts of your idea ? + placeholder: Identify the drawbacks and impacts while being neutral on your idea + validations: + required: true + - type: textarea + id: unresolved_question + attributes: + label: "Unresolved questions" + description: What questions still remain unresolved ? + placeholder: Identify any unresolved issues. + validations: + required: false \ No newline at end of file