commit f755918e3f325f28658700ca954f8a47ec58d021
parent 00c0a856bebf73e2cfdf28244b49cae2ed05ed0c
Author: Steven Atkinson <steven@atkinson.mn>
Date: Tue, 15 Oct 2024 11:15:36 -0700
Update bug_report.md
Improve bug report template
Diffstat:
1 file changed, 10 insertions(+), 7 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -9,30 +9,33 @@ assignees: ''
**Thanks for taking the time to write a bug report!** Use the following prompts to help you describe what's going on. The more info you provide, the easier it'll be to understand how to fix it for you without having to come back and ask you questions.
-**Describe the bug**
+## Description
A clear and concise description of what the bug is.
-**To Reproduce**
+## To reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
-**Expected behavior**
+## Expected behavior
A clear and concise description of what you expected to happen.
-**Screenshots**
+## Screenshots
If applicable, add screenshots to help explain your problem.
-**Desktop (please complete the following information):**
+## Computer info
+**(please provide the following information):**
- OS [e.g. Windows 10, macOS 10.15]
- - Plugin version [e.g. 0.6.1]
+ - Onboard graphics & version
+ - Plugin version [e.g. 0.7.10]
- Standalone, VST3, or AU
- DAW (if applicable)
- Audio interface [e.g. Focusrite Scarlett Solo 3rd Gen]
- Sample rate [e.g. 44.1 kHz]
- Buffer size [e.g. 256 samples]
+ - **Does the bug _not_ happen under some other conditions?** If you can find what _one_ thing makes the difference between the bug appearing and not, this _drastically_ improves the chances I can fix it.
-**Additional context**
+## Additional context
Add any other context about the problem here.
