|
1 | 1 | # 🐛 Bug Report |
2 | 2 |
|
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. |
4 | 4 |
|
5 | 5 | --- |
6 | 6 |
|
7 | | -## 1. Summary of the Issue |
| 7 | +## 1. Core Principle Alignment |
8 | 8 |
|
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. |
10 | 10 |
|
11 | | -**Title:** |
| 11 | +## 2. Summary of the Issue |
12 | 12 |
|
13 | | -## 2. Environment & Context |
| 13 | +A brief, high-impact description of the bug. What is broken or incorrect? |
14 | 14 |
|
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.' --> |
16 | 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) |
| 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) |
20 | 20 |
|
21 | 21 | ## 3. Steps to Reproduce |
22 | 22 |
|
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. |
24 | 24 |
|
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: |
28 | 28 |
|
29 | 29 | ## 4. Expected Behavior |
30 | 30 |
|
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? |
32 | 32 |
|
33 | 33 | ## 5. Actual Behavior |
34 | 34 |
|
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). |
36 | 36 |
|
37 | | -## 6. Proposed Fix (Optional) |
| 37 | +## 6. Environment / Context |
38 | 38 |
|
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): |
40 | 40 |
|
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) |
42 | 44 |
|
43 | | -text |
44 | | -[Insert proposed text here] |
| 45 | +## 7. Proposed Fix (Optional but Encouraged) |
45 | 46 |
|
| 47 | +If you have already identified the precise correction, please include it here. This significantly accelerates the verification and merge cycle. |
46 | 48 |
|
47 | | -## 7. Diagnostics & Evidence |
| 49 | +markdown |
| 50 | +// Proposed change in X file: |
48 | 51 |
|
49 | | -<!-- Attach screenshots, file excerpts, or console output if relevant. --> |
| 52 | +- Old Line |
| 53 | ++ New Line |
50 | 54 |
|
51 | | -* **Screenshot/Excerpt:** (Attach or link evidence) |
52 | 55 |
|
53 | | ---- |
| 56 | +--- |
54 | 57 |
|
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