diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..19de73af --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,155 @@ +name: Bug Report +description: Report a bug or unexpected behavior in OpenRAG +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a bug! Please fill out the form below to help us understand and fix the issue. + + - type: input + id: openrag-version + attributes: + label: OpenRAG Version + description: What version of OpenRAG are you using? Run `openrag --version` or check your package version. + placeholder: "e.g., 0.1.0" + validations: + required: true + + - type: dropdown + id: deployment-method + attributes: + label: Deployment Method + description: How are you running OpenRAG? + options: + - uvx (uvx openrag) + - uv add (installed in project) + - Docker + - Podman + - Local development (make dev) + - Other + validations: + required: true + + - type: input + id: os + attributes: + label: Operating System + description: What operating system are you using? + placeholder: "e.g., macOS 14.0, Ubuntu 22.04, Windows 11" + validations: + required: true + + - type: input + id: python-version + attributes: + label: Python Version + description: What Python version are you using? Run `python --version` to check. + placeholder: "e.g., 3.13.0" + validations: + required: false + + - type: dropdown + id: affected-area + attributes: + label: Affected Area + description: Which area(s) of OpenRAG does this bug affect? Select all that apply. + multiple: true + options: + - Ingestion (document processing, upload, Docling) + - Retrieval (search, OpenSearch, hybrid search) + - Chat (chat interface, conversations, AI responses) + - Knowledge Filters (partitions, document filtering) + - Settings (configuration, model providers) + - TUI (Terminal User Interface) + - Connectors (Google Drive, OneDrive, SharePoint) + - Frontend (Next.js UI, components) + - Backend/API (Python/Starlette) + - Infrastructure (Docker, OpenSearch, Langflow) + - SDK (Python or TypeScript SDK) + - Onboarding (setup wizard, initial configuration) + - Authentication (OIDC, API keys) + - Other + validations: + required: true + + - type: textarea + id: bug-description + attributes: + label: Bug Description + description: A clear and concise description of what the bug is. + placeholder: Describe the bug... + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + 4. See error + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + placeholder: What should have happened? + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: Actual Behavior + description: A clear and concise description of what actually happened. + placeholder: What actually happened? + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Relevant Logs + description: | + Please copy and paste any relevant log output. + You can get logs using `make logs` for Docker deployments or check the terminal output. + This will be automatically formatted into code, so no need for backticks. + render: shell + validations: + required: false + + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem. + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Add any other context about the problem here (e.g., browser version, specific document types, model provider being used). + validations: + required: false + + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: Please confirm the following before submitting. + options: + - label: I have searched existing issues to ensure this bug hasn't been reported before. + required: true + - label: I have provided all the requested information. + required: true + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..a39c8e77 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,15 @@ +blank_issues_enabled: false +contact_links: + - name: OpenRAG Documentation + url: https://docs.openr.ag/ + about: Learn more about OpenRAG's features, installation, and configuration. + - name: Troubleshooting Guide + url: https://docs.openr.ag/support/troubleshoot + about: Check the troubleshooting guide for common issues and solutions. + - name: GitHub Discussions + url: https://github.com/langflow-ai/openrag/discussions + about: Ask questions and discuss ideas with the community. + - name: Contributing Guide + url: https://github.com/langflow-ai/openrag/blob/main/CONTRIBUTING.md + about: Learn how to contribute to OpenRAG development. + diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 00000000..9ba1eb39 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,106 @@ +name: Documentation Issue +description: Report an issue with documentation or request new documentation +title: "[Docs]: " +labels: ["documentation"] +body: + - type: markdown + attributes: + value: | + Thanks for helping improve OpenRAG's documentation! Please provide details about the issue or your request. + + - type: dropdown + id: issue-type + attributes: + label: Issue Type + description: What type of documentation issue is this? + options: + - Incorrect information + - Missing documentation + - Outdated content + - Unclear or confusing + - Typo or grammatical error + - Broken links + - Request for new documentation + - Other + validations: + required: true + + - type: dropdown + id: doc-area + attributes: + label: Documentation Area + description: Which area of documentation does this relate to? + multiple: true + options: + - Getting Started / Quickstart + - Installation (uvx, Docker, Podman) + - Configuration / Settings + - Ingestion & Document Processing + - Search & Retrieval + - Chat Interface + - Knowledge Filters + - Connectors (Google Drive, OneDrive, SharePoint) + - TUI (Terminal User Interface) + - API Reference + - SDK Documentation (Python/TypeScript) + - Troubleshooting + - Contributing Guide + - Other + validations: + required: true + + - type: input + id: doc-url + attributes: + label: Documentation URL + description: If applicable, provide a link to the specific documentation page. + placeholder: "https://docs.openr.ag/..." + validations: + required: false + + - type: textarea + id: current-content + attributes: + label: Current Content + description: If reporting an issue, what does the documentation currently say? + placeholder: Quote or describe the current documentation content. + validations: + required: false + + - type: textarea + id: issue-description + attributes: + label: Issue Description + description: Describe the problem or what documentation you'd like to see added. + placeholder: | + For issues: Explain what's wrong or confusing about the current documentation. + For requests: Describe what topic you'd like documented and why it would be helpful. + validations: + required: true + + - type: textarea + id: suggested-content + attributes: + label: Suggested Content + description: If you have suggestions for how to fix or improve the documentation, please share them. + placeholder: Provide suggested text, corrections, or an outline for new documentation. + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Add any other context, screenshots, or examples here. + validations: + required: false + + - type: checkboxes + id: contribution + attributes: + label: Contribution + description: Would you be interested in contributing to fix this documentation issue? + options: + - label: I would be willing to submit a pull request to fix this issue. + required: false + diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..f6966dca --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,113 @@ +name: Feature Request +description: Suggest a new feature or enhancement for OpenRAG +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting a feature! Please provide as much detail as possible to help us understand your request. + + - type: dropdown + id: feature-area + attributes: + label: Feature Area + description: Which area(s) of OpenRAG does this feature relate to? + multiple: true + options: + - Ingestion (document processing, upload, Docling) + - Retrieval (search, OpenSearch, hybrid search) + - Chat (chat interface, conversations, AI responses) + - Knowledge Filters (partitions, document filtering) + - Settings (configuration, model providers) + - TUI (Terminal User Interface) + - Connectors (Google Drive, OneDrive, SharePoint) + - Frontend (Next.js UI, components) + - Backend/API (Python/Starlette) + - Infrastructure (Docker, OpenSearch, Langflow) + - SDK (Python or TypeScript SDK) + - Onboarding (setup wizard, initial configuration) + - Authentication (OIDC, API keys) + - New Area + validations: + required: true + + - type: textarea + id: problem-description + attributes: + label: Problem Description + description: Is your feature request related to a problem? Please describe. + placeholder: A clear and concise description of what the problem is. E.g., "I'm always frustrated when..." + validations: + required: true + + - type: textarea + id: proposed-solution + attributes: + label: Proposed Solution + description: Describe the solution you'd like to see implemented. + placeholder: A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + id: use-case + attributes: + label: Use Case + description: Describe your use case and how this feature would benefit you or others. + placeholder: | + As a [type of user], I want [goal] so that [benefit]. + + Example: As a developer, I want to filter documents by custom metadata so that I can organize my knowledge base more effectively. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Describe any alternative solutions or features you've considered. + placeholder: What other approaches have you thought about? Why wouldn't they work as well? + validations: + required: false + + - type: dropdown + id: priority + attributes: + label: Priority + description: How important is this feature to your workflow? + options: + - Nice to have + - Would improve my workflow + - Critical for my use case + validations: + required: true + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Add any other context, mockups, screenshots, or examples about the feature request here. + validations: + required: false + + - type: checkboxes + id: contribution + attributes: + label: Contribution + description: Would you be interested in contributing to this feature? + options: + - label: I would be willing to help implement this feature. + required: false + - label: I can help test this feature once implemented. + required: false + + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: Please confirm the following before submitting. + options: + - label: I have searched existing issues and discussions to ensure this feature hasn't been requested before. + required: true +