new bug report template format

This commit is contained in:
Jack 2021-10-10 17:25:54 +01:00
parent b00148e481
commit 0e629ebce0
2 changed files with 80 additions and 37 deletions

View file

@ -1,37 +0,0 @@
---
name: Bug report
about: Create a report to help us improve
title: ""
labels: bug
assignees: ""
---
<!--
**DID YOU MAKE SURE TO CLEAR CACHE BEFORE OPENING AN ISSUE?**
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
-->
**Describe the bug** <!-- A clear and concise description of what the bug is. -->
<!-- **Did it happen in incognito mode?**
Sometimes things work in incognito mode, which allows me to further track down the issue. -->
**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 further help explain your problem. -->
**Desktop:** <!-- if you encountered an issue while using Monkeytype on your computer please complete the following information, delete this section if not-->
- OS: [] <!-- e.g. Windows 10, MacOS, Linux-->
- Browser [] <!-- e.g. Chrome, Firefox, Safari, etc... -->
- Browser Version [] <!-- e.g. 22 -->
**Additional context** <!-- Add any other details about the problem here. -->

80
.github/ISSUE_TEMPLATE/bug_report.yaml vendored Normal file
View file

@ -0,0 +1,80 @@
name: Bug report
description: Create a report to help us improve
title: "<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