|
1 | 1 | # 🐛 Bug Report |
2 | 2 |
|
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. |
| 3 | +Thank you for taking the time to report an issue. Adherence to these guidelines ensures rapid triage and resolution by the Apex Technical Authority. |
4 | 4 |
|
5 | | ---- |
| 5 | +--- |
6 | 6 |
|
7 | | -## 1. Core Principle Alignment |
| 7 | +## 1. Summary |
8 | 8 |
|
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. |
| 9 | +> Briefly describe the bug in one concise sentence. |
10 | 10 |
|
11 | | -## 2. Summary of the Issue |
| 11 | +**Example:** *The SOLID Principles documentation incorrectly cross-references Liskov Substitution Principle instead of Dependency Inversion.* |
12 | 12 |
|
13 | | -A brief, high-impact description of the bug. What is broken or incorrect? |
| 13 | +--- |
14 | 14 |
|
15 | | -<!-- e.g., 'The example code for the Strategy Pattern in the OOP section contains an unused variable.' --> |
| 15 | +## 2. Environment & Context |
16 | 16 |
|
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) |
| 17 | +This repository is treated as a static, knowledge-based artifact reviewed against **December 2025** architectural standards. Please specify where this discrepancy was observed. |
20 | 18 |
|
21 | | -## 3. Steps to Reproduce |
| 19 | +### Artifact Location |
22 | 20 |
|
23 | | -Provide a precise, numbered sequence that allows a maintainer to replicate the error immediately. |
| 21 | +* **File Path:** `[e.g., /patterns/creational/factory.md]` |
| 22 | +* **Section/Heading:** `[e.g., Open/Closed Principle Implementation]` |
| 23 | +* **Observed Version/State:** `[If applicable, e.g., The current main branch state]` |
24 | 24 |
|
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: |
| 25 | +### Reproduction Steps |
28 | 26 |
|
29 | | -## 4. Expected Behavior |
| 27 | +Provide clear, numbered steps to reproduce the reported issue. If the issue is conceptual or documentation-based, describe the expected vs. actual content. |
30 | 28 |
|
31 | | -What should have happened according to software engineering best practices or the description provided? |
| 29 | +1. Navigate to the relevant documentation section. |
| 30 | +2. [Step 2] |
| 31 | +3. [Step 3] |
32 | 32 |
|
33 | | -## 5. Actual Behavior |
| 33 | +--- |
34 | 34 |
|
35 | | -What actually happened? (Screenshots or copied text output are highly valuable here). |
| 35 | +## 3. Expected vs. Actual Behavior |
36 | 36 |
|
37 | | -## 6. Environment / Context |
| 37 | +### Expected Behavior |
38 | 38 |
|
39 | | -If this relates to an external tool or standard mentioned within the Handbook (e.g., SOLID context, specific language version): |
| 39 | +What should the documentation or principle illustrate according to **2026 Technical Excellence Standards**? |
40 | 40 |
|
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) |
| 41 | +### Actual Behavior |
44 | 42 |
|
45 | | -## 7. Proposed Fix (Optional but Encouraged) |
| 43 | +What is currently written or displayed that is incorrect or confusing? |
46 | 44 |
|
47 | | -If you have already identified the precise correction, please include it here. This significantly accelerates the verification and merge cycle. |
| 45 | +--- |
| 46 | + |
| 47 | +## 4. Proposed Resolution (Optional but Encouraged) |
| 48 | + |
| 49 | +If you have already identified the fix, please propose the specific textual or structural correction here. This accelerates verification. |
48 | 50 |
|
49 | 51 | markdown |
50 | | -// Proposed change in X file: |
| 52 | +<!-- Insert proposed correction snippet here --> |
51 | 53 |
|
52 | | -- Old Line |
53 | | -+ New Line |
54 | 54 |
|
| 55 | +--- |
55 | 56 |
|
56 | | ---- |
| 57 | +## 5. Artifact Verification Checklist |
57 | 58 |
|
58 | | -**Repository Reference:** [DevCore Software Design Principles Handbook](https://github.com/chirag127/DevCore-Software-Design-Principles-Handbook) |
| 59 | +* [ ] I have confirmed this is not already covered in the `AGENTS.md` directives. |
| 60 | +* [ ] I have verified the issue against the established repository standard (CC BY-NC 4.0). |
| 61 | +* [ ] All steps in Section 2 are verifiable without requiring external tooling (as this is a documentation artifact). |
0 commit comments