From ca4c2617770f047472fd30fe242f4520eb635b32 Mon Sep 17 00:00:00 2001 From: 4Source <38220764+4Source@users.noreply.github.com> Date: Sat, 25 May 2024 10:13:50 +0200 Subject: [PATCH] Improved issue templates (#963) * Replace bug_report with form instead of template * Replace feature_request with form instead of template * Fix linting --- .github/ISSUE_TEMPLATE/bug_report.md | 34 -------- .github/ISSUE_TEMPLATE/bug_report.yml | 91 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 16 ---- .github/ISSUE_TEMPLATE/feature_request.yml | 30 +++++++ 4 files changed, 121 insertions(+), 50 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index b8afae53..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Bug report -about: Create a bug report to help us improve the plugin. -title: "[BUG]" -labels: 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 the bug. This could be the logs in the developer console (`CTRL` + `SHIFT` + `i`). - -**Versions (please complete the following information):** - -- OS: [e.g. iOS] -- Obsidian version: [e.g. v0.12.4] -- Plugin version: [e.g. v1.4.9] -- If on desktop, Installer version: [run `this.navigator.appVersion` on the developer console, e.g. `5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) obsidian/0.12.3 Chrome/89.0.4389.128 Electron/12.0.6 Safari/537.36"`] - -**Additional context** -Add any other context about the problem here (e.g. the markdown producing the error). diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..c5fefeba --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,91 @@ +name: Bug report +description: Create a bug report to help us improve the plugin. +title: "[Bug]: " +labels: ["bug"] + +body: + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + placeholder: Tell us what happened that you didn't expect [...] + validations: + required: true + - type: textarea + id: bug-reproduce-steps + attributes: + label: To Reproduce + description: Steps to reproduce the behavior + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + 4. See error" + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + placeholder: Tell us what you think should have happened... + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain the bug. This could be the logs in the developer console (`CTRL` + `SHIFT` + `i`). + placeholder: Paste image here + validations: + required: false + - type: input + id: operating-system + attributes: + label: OS of your device + placeholder: e.g. Win10 + validations: + required: true + - type: input + id: obsidian-version + attributes: + label: Obsidian version + placeholder: e.g. v0.12.4 + validations: + required: true + - type: input + id: plugin-version + attributes: + label: Plugin version + placeholder: "e.g. v1.4.9" + validations: + required: true + - type: input + id: installer-version + attributes: + label: Installer version + description: If on desktop [run `this.navigator.appVersion` on the developer console, e.g. `5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) obsidian/0.12.3 Chrome/89.0.4389.128 Electron/12.0.6 Safari/537.36"`] + placeholder: "e.g. v1.4.9" + validations: + required: false + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context about the problem here (e.g. the markdown producing the error). + placeholder: Explain any additional context [...] + validations: + required: false + - type: textarea + id: config-files + attributes: + label: Config file + description: | + Drag & drop your config file here [VAULT/.obsidian/plugins/obsidian-spaced-repetition/data.json] + Drag & drop your violated file containing your error here + placeholder: | + data.json + violated_file.md + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 4f153ba0..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this plugin. -title: "[FEAT]" -labels: enhancement -assignees: "" ---- - -**Is your feature request related to a problem? 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. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..79a8dfa0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,30 @@ +name: Feature request +description: Suggest an idea for this plugin. +title: "[FEAT]: " +labels: ["enhancement"] + +body: + - type: textarea + id: problem-description + attributes: + label: Is your feature request related to a problem? Please describe. + description: A clear and concise description of what the problem is. + placeholder: I'm always frustrated when [...] + validations: + required: false + - type: textarea + id: solution-description + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + placeholder: I wanted that [...] + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. + placeholder: Explain any additional context [...] + validations: + required: false