From fc46e44ad34d5c1e227abd385ed9601585f92a51 Mon Sep 17 00:00:00 2001
From: oomokaro1 <oomokaro25@email.com>
Date: Thu, 18 Jun 2026 10:55:42 +0100
Subject: [PATCH] feat: add standard issue templates

- Add bug report template (package-specific fields)
- Add feature request template
- Add config.yml with documentation and security links
---
 .github/ISSUE_TEMPLATE/bug_report.md      | 69 ++++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml         |  8 +++
 .github/ISSUE_TEMPLATE/feature_request.md | 77 +++++++++++++++++++++++
 3 files changed, 154 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..98bc07d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,69 @@
+---
+name: "Bug Report"
+about: "Report an issue in the OrbitStream Documentation"
+title: "[BUG] "
+labels: ["bug", "documentation", "needs-triage"]
+assignees: ""
+---
+
+# Documentation Bug Report
+
+## 📝 Description
+
+<!-- A clear and concise description of the documentation issue. -->
+
+## 📄 Affected Document
+
+<!-- Which document has the issue? -->
+
+- **File**: [e.g., `architecture/backend.md`, `api/openapi.yaml`, `contract/spec.md`]
+- **Section**: [e.g., "Database Schema", "API Endpoints"]
+- **Line(s)**: [e.g., line 42-50]
+
+## 🔄 What's Wrong
+
+<!-- Is the information incorrect, outdated, incomplete, or unclear? -->
+
+- [ ] Incorrect information
+- [ ] Outdated information
+- [ ] Missing information
+- [ ] Unclear / confusing wording
+- [ ] Broken link
+- [ ] Code example doesn't work
+- [ ] Other: ___
+
+## ✅ Expected Content
+
+<!-- What should the documentation say? -->
+
+## ❌ Actual Content
+
+<!-- What does the documentation currently say? Paste the problematic text. -->
+
+## 🔍 Evidence
+
+<!-- If the docs don't match the implementation, paste evidence. -->
+
+**Documentation says:**
+```
+[Paste doc content]
+```
+
+**Actual implementation:**
+```typescript
+// Paste actual code that contradicts the docs
+```
+
+## 💡 Suggested Fix
+
+<!-- If you know how to fix it, describe the change. -->
+
+## 📎 Additional Context
+
+<!-- Any other context, links to related docs, or references. -->
+
+## ✅ Checklist
+
+- [ ] I have searched existing issues and this is not a duplicate
+- [ ] I have identified the specific document and section
+- [ ] I have described what's wrong and what it should say
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..862b2a1
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Documentation
+    url: https://github.com/your-org/OrbitStream/blob/main/orbitstream_docs/README.md
+    about: Read the OrbitStream documentation before opening an issue
+  - name: Security Vulnerability
+    url: https://github.com/your-org/OrbitStream/security/advisories/new
+    about: Report security vulnerabilities privately
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..6a7e72f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,77 @@
+---
+name: "Documentation Request"
+about: "Suggest new or improved documentation for OrbitStream"
+title: "[DOCS] "
+labels: ["documentation", "enhancement", "needs-triage"]
+assignees: ""
+---
+
+# Documentation Request
+
+## 📝 Summary
+
+<!-- A clear, one-sentence summary of the documentation you want. -->
+
+## 🎯 Problem Statement
+
+<!-- What information is missing or unclear? Who needs this documentation? -->
+
+## 💡 Proposed Content
+
+<!-- Describe what the documentation should cover. -->
+
+### Document Location
+
+- [ ] `architecture/overview.md` — System architecture
+- [ ] `architecture/backend.md` — Backend design
+- [ ] `architecture/frontend.md` — Frontend design
+- [ ] `architecture/contract.md` — Contract architecture
+- [ ] `architecture/stellar-features.md` — Stellar-specific features
+- [ ] `api/openapi.yaml` — API specification
+- [ ] `contract/spec.md` — Contract specification
+- [ ] `contract/events.md` — Contract events
+- [ ] `guides/integration-guide.md` — SDK integration
+- [ ] `guides/merchant-setup.md` — Merchant setup
+- [ ] `security/threat-model.md` — Security considerations
+- [ ] New document: ___
+
+### Content Type
+
+- [ ] New documentation (doesn't exist yet)
+- [ ] Update existing documentation (outdated or incomplete)
+- [ ] Code examples (need working examples for a feature)
+- [ ] Tutorial / walkthrough (step-by-step guide)
+- [ ] API reference (endpoint documentation)
+- [ ] Architecture decision record (ADR)
+
+## 📋 Acceptance Criteria
+
+- [ ] Criterion 1
+- [ ] Criterion 2
+- [ ] Criterion 3
+
+## 🏗️ Implementation Notes
+
+<!-- Any technical details, references to specs, or links to source code. -->
+
+### Related Source Code
+
+<!-- Link to the source code that the documentation should describe. -->
+
+- `OrbitStream_backend/src/...` — 
+- `orbitstream_contracts/src/...` — 
+- `OrbitStream-Checkout-sdk/src/...` — 
+
+### References
+
+<!-- Links to external specs, articles, or similar documentation. -->
+
+## 📎 Additional Context
+
+<!-- Any other context, mockups, or examples. -->
+
+## ✅ Checklist
+
+- [ ] I have searched existing docs and this is not a duplicate
+- [ ] I have identified where the documentation should go
+- [ ] I have described what content is needed