diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..6b2cb68 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,101 @@ +name: Bug Report +description: Report a problem to help us improve knowledge-base +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Please supply complete reproduction details to speed up resolution. + For **security vulnerabilities**, do not open an issue — see [SECURITY.md](../blob/master/SECURITY.md). + + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + placeholder: Tell us what went wrong. + validations: + required: true + + - type: dropdown + id: area + attributes: + label: Area + description: Which part of the project is affected? + options: + - Build pipeline (build-vite / fetch-apps / apps.json) + - URL rewriting / chrome injection (transform) + - Web-fragment embedding (host gateway / shadow DOM / routing) + - Standalone site / nginx / Docker + - CI / workflows + - Documentation + - Other / not sure + validations: + required: true + + - type: textarea + id: reproduction-steps + attributes: + label: Steps to Reproduce + description: Steps to reproduce the behavior OR the commands you ran. + placeholder: | + 1. Run `npm run build:headless` + 2. Start `node tests/host/server.mjs` + 3. Open '...' + 4. See error + validations: + required: true + + - type: textarea + id: expected-state + attributes: + label: Expected state + description: A clear and concise description of what you expected to happen. + placeholder: What should have happened? + validations: + required: true + + - type: dropdown + id: severity + attributes: + label: Impact / Severity + description: Level of impact + options: + - Blocker + - High + - Medium + - Low + validations: + required: true + + - type: textarea + id: evidence + attributes: + label: Attachments / Evidence + description: Logs, screenshots, traces, failing test output. + placeholder: Paste relevant excerpts. + validations: + required: false + + - type: textarea + id: environment + attributes: + label: Environment + description: How are you running knowledge-base? + placeholder: | + Node version: e.g., 24.x (run `node --version`) + OS: e.g., Windows 11, macOS 14, Ubuntu 24.04 + Mode: e.g., standalone build / Docker / embedded web-fragment + Browser (if UI): e.g., Chrome 130 + Commit / version: e.g., master @ + validations: + required: false + + - type: textarea + id: related + attributes: + label: Related / References + description: Link other issues or PRs. + placeholder: "#456, #789" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..54e40f5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Report a security vulnerability + url: https://github.com/AbsaOSS/knowledge-base/security/advisories/new + about: Please report vulnerabilities privately — do not open a public issue. See SECURITY.md. + - name: Documentation + url: https://github.com/AbsaOSS/knowledge-base#readme + about: Usage, build modes, testing, and embedding — check the README first. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..22bd29c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,65 @@ +name: Feature Request +description: Suggest an idea for this project. +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thank you for suggesting an improvement. Please provide clear, actionable detail. + + - type: textarea + id: feature-description + attributes: + label: Feature Description + description: A clear and concise description of what you want to happen. + placeholder: Describe the feature you'd like to see. + validations: + required: true + + - type: textarea + id: problem + attributes: + label: Problem / Opportunity + description: What user/business problem does this solve? Who benefits? + placeholder: Current pain, limitation, or missed opportunity. + validations: + required: true + + - type: textarea + id: acceptance + attributes: + label: Acceptance Criteria + description: Clear, testable outcomes. Use bullet points. + placeholder: | + 1. User can... + 2. Build produces... + 3. Tests cover... + validations: + required: true + + - type: textarea + id: proposed-solution + attributes: + label: Proposed Solution + description: High-level approach. Mention alternatives if considered. + placeholder: Describe the direction without full implementation detail. + validations: + required: false + + - type: textarea + id: dependencies + attributes: + label: Dependencies / Related + description: Link related issues, epics, or external docs. + placeholder: "#123, #456, ADR link" + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Any other information or screenshots about the feature request here. + placeholder: Add any other relevant context or screenshots. + validations: + required: false