Skip to content

Commit 6985125

Browse files
committed
docs: update .github/ISSUE_TEMPLATE/bug_report.md via Apex Optimizer
1 parent 4baed62 commit 6985125

File tree

1 file changed

+28
-25
lines changed

1 file changed

+28
-25
lines changed
Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,58 @@
11
# 🐛 Bug Report
22

3-
Thank you for helping maintain the integrity of the **DevCore Software Design Principles Handbook**. Please provide detailed, actionable information below.
3+
Thank you for contributing to the **DevCore Software Design Principles Handbook**. By reporting bugs, you help us maintain this resource at an elite, zero-defect standard.
44

55
---
66

7-
## 1. Summary of the Issue
7+
## 1. Core Principle Alignment
88

9-
<!-- Provide a concise, high-level title for the bug. E.g., "Incorrect SOLID Principle Definition in Chapter 3" -->
9+
Before submitting, please verify that the issue relates to a verifiable error in the documentation, examples, or structure, and not a misunderstanding of a design principle itself. We adhere strictly to SOLID, DRY, and YAGNI principles.
1010

11-
**Title:**
11+
## 2. Summary of the Issue
1212

13-
## 2. Environment & Context
13+
A brief, high-impact description of the bug. What is broken or incorrect?
1414

15-
This handbook is documentation-based, but context is still vital for reproducibility.
15+
<!-- e.g., 'The example code for the Strategy Pattern in the OOP section contains an unused variable.' -->
1616

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)
17+
[ ] **Is this a documentation error?** (Typo, broken link, unclear explanation)
18+
[ ] **Is this an example/code error?** (The code does not compile or correctly illustrate the concept)
19+
[ ] **Is this a structural/navigation issue?** (Broken TOC, bad badge link)
2020

2121
## 3. Steps to Reproduce
2222

23-
<!-- List the exact steps a maintainer must take to see the error. Be precise. -->
23+
Provide a precise, numbered sequence that allows a maintainer to replicate the error immediately.
2424

25-
1.
26-
2.
27-
3.
25+
1. Go to the file/section: `[Link to specific line/section in Handbook]`
26+
2. Execute the following action (if applicable): `[CLI command or conceptual action]`
27+
3. Observe the result:
2828

2929
## 4. Expected Behavior
3030

31-
<!-- Describe what you expected the documentation/content to state or look like according to established software engineering standards. -->
31+
What should have happened according to software engineering best practices or the description provided?
3232

3333
## 5. Actual Behavior
3434

35-
<!-- Describe exactly what you observed that deviates from the expectation. Include any incorrect text, broken links, or structural errors. -->
35+
What actually happened? (Screenshots or copied text output are highly valuable here).
3636

37-
## 6. Proposed Fix (Optional)
37+
## 6. Environment / Context
3838

39-
<!-- If you know the correction, please suggest the exact revised text or structural change here. This significantly speeds up resolution. -->
39+
If this relates to an external tool or standard mentioned within the Handbook (e.g., SOLID context, specific language version):
4040

41-
**Suggested Correction:**
41+
* **Principle/Pattern:** (e.g., Open/Closed Principle)
42+
* **Contextual Technology:** (e.g., C#, Python, Microservices)
43+
* **Browser/Tool (if applicable):** (e.g., GitHub Viewer Version)
4244

43-
text
44-
[Insert proposed text here]
45+
## 7. Proposed Fix (Optional but Encouraged)
4546

47+
If you have already identified the precise correction, please include it here. This significantly accelerates the verification and merge cycle.
4648

47-
## 7. Diagnostics & Evidence
49+
markdown
50+
// Proposed change in X file:
4851

49-
<!-- Attach screenshots, file excerpts, or console output if relevant. -->
52+
- Old Line
53+
+ New Line
5054

51-
* **Screenshot/Excerpt:** (Attach or link evidence)
5255

53-
---
56+
---
5457

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.*
58+
**Repository Reference:** [DevCore Software Design Principles Handbook](https://github.com/chirag127/DevCore-Software-Design-Principles-Handbook)

0 commit comments

Comments
 (0)