Skip to content

Commit 4017dd1

Browse files
committed
docs: update .github/ISSUE_TEMPLATE/bug_report.md via Apex Optimizer
1 parent 468456d commit 4017dd1

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# 🐛 Bug Report
2+
3+
Thank you for helping maintain the integrity of the **DevCore Software Design Principles Handbook**. Please provide detailed, actionable information below.
4+
5+
---
6+
7+
## 1. Summary of the Issue
8+
9+
<!-- Provide a concise, high-level title for the bug. E.g., "Incorrect SOLID Principle Definition in Chapter 3" -->
10+
11+
**Title:**
12+
13+
## 2. Environment & Context
14+
15+
This handbook is documentation-based, but context is still vital for reproducibility.
16+
17+
* **Reference Section/Chapter:** (e.g., Chapter 2.1: Dependency Inversion Principle)
18+
* **Document Format Encountered (If applicable):** (e.g., Rendered on GitHub Web, PDF Export, Local Clone View)
19+
* **Principle/Pattern Affected:** (e.g., Liskov Substitution, Builder Pattern)
20+
21+
## 3. Steps to Reproduce
22+
23+
<!-- List the exact steps a maintainer must take to see the error. Be precise. -->
24+
25+
1.
26+
2.
27+
3.
28+
29+
## 4. Expected Behavior
30+
31+
<!-- Describe what you expected the documentation/content to state or look like according to established software engineering standards. -->
32+
33+
## 5. Actual Behavior
34+
35+
<!-- Describe exactly what you observed that deviates from the expectation. Include any incorrect text, broken links, or structural errors. -->
36+
37+
## 6. Proposed Fix (Optional)
38+
39+
<!-- If you know the correction, please suggest the exact revised text or structural change here. This significantly speeds up resolution. -->
40+
41+
**Suggested Correction:**
42+
43+
text
44+
[Insert proposed text here]
45+
46+
47+
## 7. Diagnostics & Evidence
48+
49+
<!-- Attach screenshots, file excerpts, or console output if relevant. -->
50+
51+
* **Screenshot/Excerpt:** (Attach or link evidence)
52+
53+
---
54+
55+
*Note: All contributions are governed by the project's standards enforced by the Apex Technical Authority. See the [CONTRIBUTING.md](https://github.com/chirag127/DevCore-Software-Design-Principles-Handbook/blob/main/.github/CONTRIBUTING.md) for guidelines.*

0 commit comments

Comments
 (0)