From 4cc3c19714c381dc7bfefa319e0ddc13995367dd Mon Sep 17 00:00:00 2001 From: Seth Date: Fri, 26 Jun 2026 00:07:21 -0500 Subject: [PATCH] Revise bug report template for clarity and structure Updated the bug report template to include clearer sections and improve structure. --- .github/ISSUE_TEMPLATE/bug_report.md | 62 ++++++++++++++++------------ 1 file changed, 36 insertions(+), 26 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea7..016ad6a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,38 +1,48 @@ --- name: Bug report -about: Create a report to help us improve -title: '' -labels: '' +title: "[Bug]: " +about: Report a reproducible problem +labels: bug assignees: '' - --- -**Describe the bug** -A clear and concise description of what the bug is. + + +## Summary + +A clear and concise description of the bug. + +## Environment + +- Package version: (e.g. 3.2.1) +- OS: + +## Reproduction -**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. +1. +2. +3. -**Screenshots** -If applicable, add screenshots to help explain your problem. +### Minimal snippet -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +```js +// Provide the smallest reproducible example. +``` -**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] +## Expected behavior -**Additional context** -Add any other context about the problem here. +What did you expect to happen? + +## Actual behavior + +What actually happened? + +## Screenshots / Logs + +If applicable, add screenshots or console logs. + +## Additional context + +Add any other context or links (PRs, issues, references) here.