From 0e629ebce0942545c23006deeeaa4dc8920751c0 Mon Sep 17 00:00:00 2001 From: Jack Date: Sun, 10 Oct 2021 17:25:54 +0100 Subject: [PATCH] new bug report template format --- .github/ISSUE_TEMPLATE/bug_report.md | 37 ------------ .github/ISSUE_TEMPLATE/bug_report.yaml | 80 ++++++++++++++++++++++++++ 2 files changed, 80 insertions(+), 37 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 1ba47b1e4..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "" -labels: bug -assignees: "" ---- - - - -**Describe the bug** - - - -**To Reproduce** - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** - -**Screenshots** - -**Desktop:** - -- OS: [] -- Browser [] -- Browser Version [] - -**Additional context** diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 000000000..4ffaefc8d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,80 @@ +name: Bug report +description: Create a report to help us improve +title: "" +labels: [bug] +body: + - 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: checkboxes + attributes: + label: Did you clear cache before opening an issue? + description: Sometimes your browser has old files cached and the bug you are experiencing might be already fixed, or is just a side effect of a new update. If you don't know how to do that, this website should help https://www.pcmag.com/how-to/how-to-clear-your-cache-on-any-browser. + options: + - label: I have cleared my cache + required: true + - type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + 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: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: false + - type: textarea + attributes: + label: Environment + description: | + examples: + - **OS**: Windows 10 + - **Browser**: Google Chrome + - **Browser Version**: 94.0.4606.71 (Official Build) (64-bit) + value: | + - OS: + - Browser: + - Browser Version: + render: markdown + validations: + required: false + - type: textarea + attributes: + label: Anything else? + 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 + attributes: + label: Did you check incognito mode? + description: Sometimes bugs may be dependent on your config. If the issue does not show up in incognito mode, then this could mean it's an issue with your settings. + options: + - label: I have cleared my cache + required: false + - type: textarea + attributes: + label: Config + description: If your issue DOES NOT happen in incognito, please export your config and paste it here. + placeholder: '{"theme":"cyberspace","showKeyTips":false,"showLiveWpm":false,"showTimerProgress":false, ... "smoothCaret":true}' + validations: + required: false