From d55d437275008e5584f865a03b48fd162baf004d Mon Sep 17 00:00:00 2001 From: Timothy Jaeryang Baek Date: Mon, 18 Dec 2023 23:56:20 -0500 Subject: [PATCH] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 68 ++++++++++++++++++---------- 1 file changed, 45 insertions(+), 23 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea782..190270131 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,32 +7,54 @@ assignees: '' --- -**Describe the bug** -A clear and concise description of what the bug is. +# Bug Report -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +## Description -**Expected behavior** -A clear and concise description of what you expected to happen. +**Bug Summary:** +[Provide a brief but clear summary of the bug] -**Screenshots** -If applicable, add screenshots to help explain your problem. +**Steps to Reproduce:** +[Outline the steps to reproduce the bug. Be as detailed as possible.] -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +**Expected Behavior:** +[Describe what you expected to happen.] -**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] +**Actual Behavior:** +[Describe what actually happened.] -**Additional context** -Add any other context about the problem here. +## Environment + +- **Operating System:** [e.g., Windows 10, macOS Big Sur, Ubuntu 20.04] +- **Browser (if applicable):** [e.g., Chrome 100.0, Firefox 98.0] + +## Reproduction Details + +**Confirmation:** +- [ ] I have read and followed all the instructions provided in the README.md. +- [ ] I have reviewed the troubleshooting.md document. +- [ ] I have included the browser console logs. +- [ ] I have included the Docker container logs. + +## Logs and Screenshots + +**Browser Console Logs:** +[Include relevant browser console logs, if applicable] + +**Docker Container Logs:** +[Include relevant Docker container logs, if applicable] + +**Screenshots (if applicable):** +[Attach any relevant screenshots to help illustrate the issue] + +## Installation Method + +[Describe the method you used to install the project, e.g., manual installation, Docker, package manager, etc.] + +## Additional Information + +[Include any additional details that may help in understanding and reproducing the issue. This could include specific configurations, error messages, or anything else relevant to the bug.] + +## Note + +If the bug report is incomplete or does not follow the provided instructions, it may not be addressed. Please ensure that you have followed the steps outlined in the README.md and troubleshooting.md documents, and provide all necessary information for us to reproduce and address the issue. Thank you!