From db22b0c5f699e968fa83e02367a3928e662b4614 Mon Sep 17 00:00:00 2001 From: Jake Turner Date: Fri, 13 Mar 2026 07:13:42 +0000 Subject: [PATCH] chore: add Github issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 193 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 14 ++ .github/ISSUE_TEMPLATE/feature_request.yml | 146 ++++++++++++++++ 3 files changed, 353 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..1f1bb3c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,193 @@ +name: Bug Report +description: Report a bug or issue with Project N.O.M.A.D. +title: "[Bug]: " +labels: ["bug", "needs-triage"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a bug! Please fill out the information below to help us diagnose and fix the issue. + + **Before submitting:** + - Search existing issues to avoid duplicates + - Ensure you're running the latest version of N.O.M.A.D. + - Redact any personal or sensitive information from logs/configs + - Please don't submit issues related to running N.O.M.A.D. on Unraid or another NAS - we don't have plans to support these kinds of platforms at this time + + - type: dropdown + id: issue-category + attributes: + label: Issue Category + description: What area is this issue related to? + options: + - Installation/Setup + - AI Assistant (Ollama) + - Knowledge Base/RAG (Document Upload) + - Docker/Container Issues + - GPU Configuration + - Content Downloads (ZIM, Maps, Collections) + - Service Management (Start/Stop/Update) + - System Performance/Resources + - UI/Frontend Issue + - Other + validations: + required: true + + - type: textarea + id: description + attributes: + label: Bug Description + description: Provide a clear and concise description of what the bug is + placeholder: What happened? What did you expect to happen? + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Steps to Reproduce + description: How can we reproduce this issue? + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. See error + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: What did you expect to happen? + placeholder: Describe the expected outcome + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: Actual Behavior + description: What actually happened? + placeholder: Describe what actually occurred, including any error messages + validations: + required: true + + - type: input + id: nomad-version + attributes: + label: N.O.M.A.D. Version + description: What version of N.O.M.A.D. are you running? (Check Settings > Update or run `docker ps` and check nomad_admin image tag) + placeholder: "e.g., 1.29.0" + validations: + required: true + + - type: dropdown + id: os + attributes: + label: Operating System + description: What OS are you running N.O.M.A.D. on? + options: + - Ubuntu 24.04 + - Ubuntu 22.04 + - Ubuntu 20.04 + - Debian 13 (Trixie) + - Debian 12 (Bookworm) + - Debian 11 (Bullseye) + - Other Debian-based + - Other (not yet officially supported) + validations: + required: true + + - type: input + id: docker-version + attributes: + label: Docker Version + description: What version of Docker are you running? (`docker --version`) + placeholder: "e.g., Docker version 24.0.7" + + - type: dropdown + id: gpu-present + attributes: + label: Do you have a dedicated GPU? + options: + - "Yes" + - "No" + - "Not sure" + validations: + required: true + + - type: input + id: gpu-model + attributes: + label: GPU Model (if applicable) + description: What GPU model do you have? (Check Settings > System or run `nvidia-smi` if NVIDIA GPU) + placeholder: "e.g., NVIDIA GeForce RTX 3060" + + - type: textarea + id: system-specs + attributes: + label: System Specifications + description: Provide relevant system specs (CPU, RAM, available disk space) + placeholder: | + CPU: + RAM: + Available Disk Space: + GPU (if any): + + - type: textarea + id: service-status + attributes: + label: Service Status (if relevant) + description: If this is a service-related issue, what's the status of relevant services? (Check Settings > Apps or run `docker ps`) + placeholder: | + Paste output from `docker ps` or describe service states from the UI + + - type: textarea + id: logs + attributes: + label: Relevant Logs + description: | + Include any relevant logs or error messages. **Please redact any personal/sensitive information.** + + Useful commands for collecting logs: + - N.O.M.A.D. management app: `docker logs nomad_admin` + - Ollama: `docker logs nomad_ollama` + - Qdrant: `docker logs nomad_qdrant` + - Specific service: `docker logs nomad_` + placeholder: Paste relevant log output here + render: shell + + - type: textarea + id: browser-console + attributes: + label: Browser Console Errors (if UI issue) + description: If this is a UI issue, include any errors from your browser's developer console (F12) + placeholder: Paste browser console errors here + render: javascript + + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem (drag and drop images here) + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Add any other context about the problem here (network setup, custom configurations, recent changes, etc.) + + - type: checkboxes + id: terms + attributes: + label: Pre-submission Checklist + description: Please confirm the following before submitting + options: + - label: I have searched for existing issues that might be related to this bug + required: true + - label: I am running the latest version of Project N.O.M.A.D. (or have noted my version above) + required: true + - label: I have redacted any personal or sensitive information from logs and screenshots + required: true + - label: This issue is NOT related to running N.O.M.A.D. on an unsupported/non-Debian-based OS + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..c0a662d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: 💬 Discord Community + url: https://discord.com/invite/crosstalksolutions + about: Join our Discord community for general questions, support, and discussions + - name: 📖 Documentation + url: https://projectnomad.us + about: Check the official documentation and guides + - name: 🏆 Community Leaderboard + url: https://benchmark.projectnomad.us + about: View the N.O.M.A.D. benchmark leaderboard + - name: 🤝 Contributing Guide + url: https://github.com/Crosstalk-Solutions/project-nomad/blob/main/CONTRIBUTING.md + about: Learn how to contribute to Project N.O.M.A.D. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..9a86a68 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,146 @@ +name: Feature Request +description: Suggest a new feature or enhancement for Project N.O.M.A.D. +title: "[Feature]: " +labels: ["enhancement", "needs-discussion"] +body: + - type: markdown + attributes: + value: | + Thanks for your interest in improving Project N.O.M.A.D.! + + **Please note:** Feature requests are not guaranteed to be implemented. All requests are evaluated based on alignment with the project's goals, feasibility, and community demand. + + **Before submitting:** + - Search existing feature requests to avoid duplicates + - Consider if this aligns with N.O.M.A.D.'s mission: offline-first knowledge and education + + - type: dropdown + id: feature-category + attributes: + label: Feature Category + description: What area does this feature relate to? + options: + - New Service/Tool Integration + - AI Assistant Enhancement + - Knowledge Base/RAG Improvement + - Content Management (ZIM, Maps, Collections) + - UI/UX Improvement + - System Management + - Performance Optimization + - Documentation + - Security + - Other + validations: + required: true + + - type: textarea + id: problem + attributes: + label: Problem Statement + description: What problem does this feature solve? Is your feature request related to a pain point? + placeholder: I find it frustrating when... / It would be helpful if... / Users struggle with... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: Describe the feature or enhancement you'd like to see + placeholder: Add a feature that... / Change the behavior to... / Integrate with... + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternative Solutions + description: Have you considered any alternative solutions or workarounds? + placeholder: I've tried... / Another approach could be... / A workaround is... + + - type: textarea + id: use-case + attributes: + label: Use Case + description: Describe a specific scenario where this feature would be valuable + placeholder: | + As a [type of user], when I [do something], I want to [accomplish something] so that [benefit]. + + Example: Because I have a dedicated GPU, I want to be able to see in the UI if GPU support is enabled so that I can optimize performance and troubleshoot issues more easily. + + - type: dropdown + id: user-type + attributes: + label: Who would benefit from this feature? + description: What type of users would find this most valuable? + multiple: true + options: + - Individual/Home Users + - Families + - Teachers/Educators + - Students + - Survivalists/Preppers + - Developers/Contributors + - Organizations + - All Users + validations: + required: true + + - type: dropdown + id: priority + attributes: + label: How important is this feature to you? + options: + - Critical - Blocking my use of N.O.M.A.D. + - High - Would significantly improve my experience + - Medium - Would be nice to have + - Low - Minor convenience + validations: + required: true + + - type: textarea + id: implementation-ideas + attributes: + label: Implementation Ideas (Optional) + description: If you have technical suggestions for how this could be implemented, share them here + placeholder: This could potentially use... / It might integrate with... / A possible approach is... + + - type: textarea + id: examples + attributes: + label: Examples or References + description: Are there similar features in other applications? Include links, screenshots, or descriptions + placeholder: Similar to how [app name] does... / See this example at [URL] + + - type: dropdown + id: willing-to-contribute + attributes: + label: Would you be willing to help implement this? + description: Contributing increases the likelihood of implementation + options: + - "Yes - I can write the code" + - "Yes - I can help test" + - "Yes - I can help with documentation" + - "Maybe - with guidance" + - "No - I don't have the skills/time" + validations: + required: true + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Add any other context, mockups, diagrams, or information about the feature request + + - type: checkboxes + id: checklist + attributes: + label: Pre-submission Checklist + description: Please confirm the following before submitting + options: + - label: I have searched for existing feature requests that might be similar + required: true + - label: This feature aligns with N.O.M.A.D.'s mission of offline-first knowledge and education + required: true + - label: I understand that feature requests are not guaranteed to be implemented + required: true