Skip to content

Commit 3dc2d31

Browse files
committed
docs: update .github/ISSUE_TEMPLATE/bug_report.md via Apex Optimizer
1 parent 11b54cb commit 3dc2d31

File tree

1 file changed

+36
-65
lines changed

1 file changed

+36
-65
lines changed
Lines changed: 36 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,92 +1,63 @@
11
---
2-
name: 🐛 Bug Report
3-
about: Report unexpected behavior or defects in JSErrorFlow.
4-
title: "[BUG]: Brief Summary of the Issue"
5-
labels: bug, triage
6-
assignees: ""
7-
---
8-
9-
## 🚨 Summary & Intent Alignment
10-
11-
Please provide a concise, one-sentence summary of the defect. Ensure the reported behavior deviates from the documented specification.
12-
13-
> **Example:** "The extension fails to highlight errors originating from Web Workers on Chromium 119."
14-
15-
---
16-
17-
## ⚙️ Environment & Context (Mandatory)
18-
19-
This section ensures rapid triangulation of the failure domain. **Do not omit details.**
20-
21-
### A. Platform Details
22-
- **Operating System:** [e.g., macOS Sonoma 14.2, Windows 11 Pro]
23-
- **Browser:** [e.g., Chrome 119.0.6045.199, Firefox 120.0.1]
24-
- **Extension Version:** `JSErrorFlow vX.Y.Z` (Check `manifest.json` or extension details)
25-
26-
### B. Target Application Context
27-
- **URL / Domain:** (Use placeholders for sensitive sites)
28-
- **Website Framework:** [e.g., React 18, Vue 3, Vanilla JS]
2+
name: "🐞 Bug Report"
3+
about: "Report a reproducible bug or unexpected behavior to help us improve."
4+
title: "[BUG] <A brief, descriptive title>"
5+
labels: ["bug", "triage"]
6+
assignees:
7+
- "chirag127"
298

309
---
3110

32-
## 👣 Steps to Reproduce (The Critical Path)
11+
### Preliminary Checks
3312

34-
Provide a numbered, deterministic sequence that reliably triggers the issue. If the error is intermittent, describe the specific load conditions or timing required.
35-
36-
1. Open Browser to `[Target URL]`
37-
2. Ensure JSErrorFlow is actively injected.
38-
3. Execute the triggering action (e.g., "Click the Submit button").
39-
4. Observe the resulting error visualization or lack thereof.
13+
- [ ] I have searched the existing [issues](https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension/issues) to ensure this is not a duplicate bug report.
14+
- [ ] I have checked the [project documentation](https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension#readme) for any relevant information.
15+
- [ ] I am using the latest version of the extension.
4016

4117
---
4218

43-
## 🎯 Expected Behavior (The Specification)
44-
45-
What result aligns with the project's design goals (i.e., what *should* have happened)?
19+
### Bug Description
4620

47-
* [ ] The JavaScript error stack trace should appear in the extension popup within 500ms.
48-
* [ ] The affected DOM node should receive a persistent, pulsating visual indicator as defined by the current UI theme.
21+
A clear and concise description of what the bug is. What happened, and what did you expect to happen?
4922

50-
---
23+
### Steps to Reproduce
5124

52-
## 💥 Actual Behavior (The Defect)
25+
Provide the exact steps to reproduce the behavior:
5326

54-
What actually occurred that constitutes the bug?
27+
1. Go to '...'
28+
2. Click on '...'
29+
3. Scroll down to '...'
30+
4. See error
5531

56-
* [ ] The error was logged in the browser console but **not** visualized by JSErrorFlow.
57-
* [ ] The visualization caused an unexpected side effect (e.g., UI component displacement or layout shift).
32+
### Expected Behavior
5833

59-
---
34+
A clear and concise description of what you expected to happen.
6035

61-
## 🖼️ Evidence & Logs
36+
### Screenshots or Screen Recordings
6237

63-
High-quality evidence accelerates triage by 75%.
38+
If applicable, add screenshots, GIFs, or video recordings to help explain your problem. You can drag and drop files directly into this editor.
6439

65-
### A. Visual Proof
66-
(Attach screenshots or screen recordings demonstrating the discrepancy.)
40+
### Environment
6741

68-
### B. Console Output
69-
Paste the full, relevant output from the browser's Developer Tools Console. Filter by JSErrorFlow sources if possible.
42+
Please complete the following information:
7043

71-
```javascript
72-
// Paste logs here, including stack traces
73-
```
44+
- **Operating System:** [e.g., macOS Sonoma, Windows 11]
45+
- **Browser & Version:** [e.g., Chrome 125.0.6422.112, Firefox 126.0]
46+
- **Extension Version:** [e.g., v1.0.1]
7447

75-
---
48+
### Console Logs & Technical Details
7649

77-
## ⚖️ Impact Assessment (Severity)
50+
Please open the developer console (F12 or Ctrl+Shift+I) and paste any relevant error messages or stack traces below.
7851

79-
How severely does this defect impede core functionality?
52+
<details>
53+
<summary>Click to expand console logs</summary>
8054

81-
- [ ] **P0 - Critical:** Core visualization functionality completely blocked. High developer downtime incurred.
82-
- [ ] **P1 - High:** Major error handling path broken; workaround requires disabling the extension.
83-
- [ ] **P2 - Medium:** Minor functionality impaired; aesthetic inconsistency or edge-case handling failure.
84-
- [ ] **P3 - Low:** Typo, documentation error, or non-critical performance degradation.
55+
text
56+
(Paste your logs here)
8557

86-
---
8758

88-
## 🤖 AI Agent Directives for Resolution
59+
</details>
8960

90-
**Agent Focus:** Verify against the LATEST TypeScript Strictness settings. Ensure the Content Script's message passing to the Background Service Worker uses the high-reliability `chrome.runtime.sendMessage` pattern (asynchronous). Check Event Listener Cleanup in `cleanupOnDomDetach` to prevent memory leaks.
61+
### Additional Context
9162

92-
**Target Fix Location:** `src/content-script.ts` and related DOM manipulation handlers.
63+
Add any other context about the problem here. For example, is this happening on a specific website or framework (React, Vue, etc.)? Is it intermittent or always reproducible?

0 commit comments

Comments
 (0)