From c43006fcc4637014c33ef657c3e7fa9c26b305fe Mon Sep 17 00:00:00 2001 From: Syed Ahmed Mohi Uddin Hasan Date: Tue, 28 Apr 2026 20:51:03 +0300 Subject: [PATCH] Revise bug report template for clarity and detail Enhanced bug report template with detailed sections for impact assessment, reproduction steps, and diagnostics. --- .github/ISSUE_TEMPLATE/bug_report.md | 109 ++++++++++++++++++++------- 1 file changed, 82 insertions(+), 27 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index cb4ccf0..38fa12e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,41 +1,96 @@ --- -name: Bug report -about: Create a report to help us improve -title: "[BUG] " -labels: bug +name: Bug Report +about: Report a defect to help us improve reliability and performance +title: "[BUG]: " +labels: ["bug", "needs-triage"] assignees: '' +--- + +## ๐Ÿž Summary +Provide a concise, high-level description of the issue. --- -**Describe the bug** -A clear and concise description of what the bug is. +## ๐Ÿ“Š Impact +- **Severity:** (Critical / High / Medium / Low) +- **Frequency:** (Always / Often / Intermittent / Rare) +- **User Impact:** (e.g. crash, data loss, UI glitch, performance degradation) + +--- + +## ๐Ÿงญ Environment +Provide complete environment details: +- **App Version:** (e.g. 1.2.3) +- **Release Channel:** (Stable / RC / Beta / Nightly) +- **OS & Version:** (e.g. Windows 11 23H2, Ubuntu 24.04) +- **CPU:** +- **RAM:** +- **GPU(s):** +- **Driver Version(s):** (e.g. NVIDIA 555.xx) +- **Installation Type:** (Clean install / Upgrade / Portable / Containerized) + +--- -**To Reproduce** -Steps to reproduce the behavior: +## ๐Ÿ” Steps to Reproduce +Provide a minimal, deterministic reproduction flow: 1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +2. Click on '...' +3. Perform '...' +4. Observe the issue + +> โš ๏ธ If reproduction is inconsistent, describe known patterns or conditions. + +--- + +## โœ… Expected Result +Describe the correct or intended behavior. + +--- -**Expected behavior** -A clear and concise description of what you expected to happen. +## โŒ Actual Result +Describe what actually happens. -**Screenshots** -If applicable, add screenshots to help explain your problem. +--- + +## ๐Ÿ“ธ Evidence +Attach relevant artifacts: +- Screenshots +- Screen recordings +- Crash dialogs -**Version affected (please complete the following information):** - - Version number [e.g. 0.4.5.5] - - RC or STABLE? +--- -**NVIDIA driver version** -Which one do you use? +## ๐Ÿ“‚ Logs & Diagnostics +Provide diagnostic data: +- Enable debug/verbose logging +- Reproduce the issue +- Attach logs as `.zip` -**Hardware** -Describe GPUs used and how are GPUs connected to the motherboard. -CPU? +Optional but helpful: +- Stack traces +- Crash dumps +- Profiling data -**Logs** -Activate logging first, then record event - bug - then export logs into a .zip file and attach it when submitting this issue. +--- + +## ๐Ÿงช Regression? +- **Is this a regression?** (Yes / No / Unknown) +- **Last Known Working Version:** + +--- + +## ๐Ÿ” Workarounds +List any known temporary fixes or mitigations. + +--- + +## ๐Ÿงฉ Additional Context +Include any other relevant details (config changes, plugins, network conditions, etc.). + +--- -**Additional context** -Add any other context about the problem here. +## โœ… Pre-Submission Checklist +- [ ] I have searched for existing issues +- [ ] I have provided reproducible steps +- [ ] I have included logs or diagnostic data +- [ ] I have filled in environment details