From d190567a209346bc1da2082db8b391762abbd7fd Mon Sep 17 00:00:00 2001 From: Livio Spring Date: Fri, 11 Nov 2022 13:40:25 +0100 Subject: [PATCH] fix issue template (#4690) --- .github/ISSUE_TEMPLATE/BUG_REPORT.yaml | 79 ++++++++++++++++---------- .github/ISSUE_TEMPLATE/bug_report.md | 38 ------------- 2 files changed, 49 insertions(+), 68 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml index f32545903f..c4193d56a6 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml @@ -2,64 +2,83 @@ name: Bug Report description: Create a report to help us improve ZITADEL title: "[Bug]: " labels: ["type: bug", "state: triage"] -assignees: body: - type: markdown attributes: - value: | - Thanks for taking the time to fill out this bug report! + value: | + Thanks for taking the time to fill out this bug report! - type: checkboxes id: preflight attributes: - label: Preflight Checklist - options: + label: Preflight Checklist + options: - label: - I could not find a solution in the documentation, the existing issues or discussions + I could not find a solution in the documentation, the existing issues or discussions required: true - label: - I have joined the [ZITADEL chat](https://zitadel.com/chat) + I have joined the [ZITADEL chat](https://zitadel.com/chat) - type: dropdown id: environment attributes: - label: Environment - description: How do you use ZITADEL? - options: - - ZITADEL Cloud - - Selfhosted + label: Environment + description: How do you use ZITADEL? + options: + - ZITADEL Cloud + - Self-hosted + validations: required: true - type: textarea id: description attributes: - label: Describe the bug - description: A clear and concise description of what the bug is. - required: true + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true - type: textarea id: reproduce attributes: - label: To reproduce - description: Steps to reproduce the behaviour - required: true + label: To reproduce + description: Steps to reproduce the behaviour + placeholder: | + Steps to reproduce the behavior: + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true - type: textarea id: screenshots - label: Screenshots - placeholder: If applicable, add screenshots to help explain your problem. + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem. - type: textarea id: expected - label: Expected behavior - placeholder: A clear and concise description of what you expected to happen. + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. - type: input id: version - label: Version - description: Which version of ZITADEL are you using. + attributes: + label: Version + description: Which version of ZITADEL are you using. - type: textarea id: os - label: Operating System - description: Please complete information about your operating-system, device, browser, etc. + attributes: + label: Operating System + description: Please complete information about your operating-system, device, browser, etc. + placeholder: | + Device: [e.g. Windows, Mac, iPhone6] + OS: [e.g. iOS8.1, Windows] + Browser [e.g. chrome, stock browser, safari] + Version [e.g. 22] - type: textarea id: config - label: Relevant Configuration - description: Add any relevant configurations that could help as. Make sure to redact any sensitive information. + attributes: + label: Relevant Configuration + description: Add any relevant configurations that could help as. Make sure to redact any sensitive information. - type: textarea id: additional - label: Additional Context - description: Please add any other infos that could be useful. \ No newline at end of file + attributes: + label: Additional Context + description: Please add any other infos that could be useful. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index f355035e53..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: "\U0001F41B Bug report" -about: Create a report to help us improve -title: '' -labels: 'state: triage, type: bug' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here.