diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..6f8cef45 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,143 @@ +name: ๐Ÿ› Bug Report +description: Report a bug or unexpected behavior +title: "[Bug]: " +labels: ["bug", "needs-triage"] +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 reproduce the issue. + + - type: dropdown + id: component + attributes: + label: Component + description: Which component is affected? + options: + - Core Agent + - LLM Integration (OpenAI/Gemini/Claude) + - STT (Speech-to-Text) + - TTS (Text-to-Speech) + - Video Processing + - Audio Processing + - Plugin System + - Edge/Stream Integration + - Examples + - Documentation + - Other + validations: + required: true + + - type: dropdown + id: plugin + attributes: + label: Plugin (if applicable) + description: Which plugin is affected? + options: + - Not applicable + - anthropic + - cartesia + - deepgram + - elevenlabs + - gemini + - getstream + - kokoro + - krisp + - moonshine + - openai + - silero + - smart_turn + - ultralytics + - wizper + - xai + - Other + validations: + required: false + + - type: textarea + id: 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 + 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 + attributes: + label: Expected Behavior + description: What you expected to happen + placeholder: Describe what should happen... + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened + placeholder: Describe what actually happened... + validations: + required: true + + - type: textarea + id: environment + attributes: + label: Environment + description: Environment details + placeholder: | + - OS: [e.g., macOS 14.0, Ubuntu 22.04] + - Python version: [e.g., 3.12.11] + - Vision Agents version: [e.g., 0.1.0] + - Plugin versions: [e.g., openai-plugin 0.1.0] + validations: + required: true + + - type: textarea + id: code + attributes: + label: Code Sample + description: Minimal code to reproduce the issue + render: python + placeholder: | + ```python + # Your code here + ``` + validations: + required: false + + - type: textarea + id: logs + attributes: + label: Error Logs + description: Relevant error messages or logs + render: shell + placeholder: | + ``` + Paste error logs here + ``` + validations: + required: false + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Any other context about the problem + placeholder: Add any other context about the problem here... + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..d405f12e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: ๐Ÿ’ฌ Discord Community + url: https://discord.gg/RkhX9PxMS6 + about: Join our Discord community for discussions and support + - name: ๐Ÿ“š Documentation + url: https://visionagents.ai + about: Check our documentation for guides and API reference + - name: ๐Ÿ› Bug Reports + url: https://github.com/GetStream/Vision-Agents/issues/new?template=bug_report.yml + about: Report a bug or unexpected behavior + - name: โœจ Feature Requests + url: https://github.com/GetStream/Vision-Agents/issues/new?template=feature_request.yml + about: Suggest a new feature or enhancement diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..a26a9c6b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,117 @@ +name: โœจ Feature Request +description: Suggest a new feature or enhancement +title: "[Feature]: " +labels: ["enhancement", "needs-triage"] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting a new feature! Please fill out the form below to help us understand your request. + + - type: dropdown + id: component + attributes: + label: Component + description: Which component would this feature affect? + options: + - Core Agent + - LLM Integration + - STT (Speech-to-Text) + - TTS (Text-to-Speech) + - Video Processing + - Audio Processing + - Plugin System + - Edge/Stream Integration + - Examples + - Documentation + - New Plugin + - Other + validations: + required: true + + - type: textarea + id: feature + attributes: + label: Feature Description + description: A clear and concise description of the feature you'd like to see + placeholder: Describe the feature... + validations: + required: true + + - type: textarea + id: problem + attributes: + label: Problem Statement + description: What problem does this feature solve? + placeholder: Describe the problem this feature would solve... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: Describe your proposed solution + placeholder: Describe how you think this feature should work... + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternative Solutions + description: Any alternative solutions or workarounds you've considered + placeholder: Describe any alternatives you've considered... + validations: + required: false + + - type: textarea + id: use_cases + attributes: + label: Use Cases + description: Describe specific use cases for this feature + placeholder: | + 1. Use case 1 + 2. Use case 2 + 3. Use case 3 + validations: + required: true + + - type: textarea + id: code + attributes: + label: Code Example + description: If you have ideas for the API, show us how it might look + render: python + placeholder: | + ```python + # Example of how the feature might be used + ``` + validations: + required: false + + - type: checkboxes + id: impact + attributes: + label: Impact Assessment + description: What would this feature impact? + options: + - label: Breaking change to existing API + required: false + - label: New plugin required + required: false + - label: Documentation updates needed + required: false + - label: Example updates needed + required: false + - label: Performance implications + required: false + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Any other context, mockups, or references + placeholder: Add any other context, screenshots, or references here... + validations: + required: false diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..51d2d420 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,41 @@ +## Description + + + +## Type of Change + + + +- [ ] ๐Ÿ› Bug fix (non-breaking change which fixes an issue) +- [ ] โœจ New feature (non-breaking change which adds functionality) +- [ ] ๐Ÿ’ฅ Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] ๐Ÿ“š Documentation update +- [ ] ๐Ÿ”ง Refactoring (no functional changes) +- [ ] โšก Performance improvement +- [ ] ๐Ÿงช Test improvements +- [ ] ๐Ÿ”Œ Plugin/Integration changes +- [ ] ๐Ÿ“ฆ Dependencies update + +## Related Issues + + + +Fixes # +Closes # +Related to # + +## Changes Made + + + +## Examples/Usage + + + +```python +# Example code showing the new functionality +``` + +## Screenshots/Videos + + \ No newline at end of file