Skip to content

Commit b058a2e

Browse files
tjirabtjirab
committed
issue templates
1 parent 75c5a1d commit b058a2e

File tree

3 files changed

+274
-0
lines changed

3 files changed

+274
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug or unexpected behavior
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the form below to help us understand and reproduce the issue.
10+
11+
- type: dropdown
12+
id: component
13+
attributes:
14+
label: Component
15+
description: Which component is affected?
16+
options:
17+
- Core Agent
18+
- LLM Integration (OpenAI/Gemini/Claude)
19+
- STT (Speech-to-Text)
20+
- TTS (Text-to-Speech)
21+
- Video Processing
22+
- Audio Processing
23+
- Plugin System
24+
- Edge/Stream Integration
25+
- Examples
26+
- Documentation
27+
- Other
28+
validations:
29+
required: true
30+
31+
- type: dropdown
32+
id: plugin
33+
attributes:
34+
label: Plugin (if applicable)
35+
description: Which plugin is affected?
36+
options:
37+
- Not applicable
38+
- anthropic
39+
- cartesia
40+
- deepgram
41+
- elevenlabs
42+
- gemini
43+
- getstream
44+
- kokoro
45+
- krisp
46+
- moonshine
47+
- openai
48+
- silero
49+
- smart_turn
50+
- ultralytics
51+
- wizper
52+
- xai
53+
- Other
54+
validations:
55+
required: false
56+
57+
- type: textarea
58+
id: description
59+
attributes:
60+
label: Bug Description
61+
description: A clear and concise description of what the bug is
62+
placeholder: Describe the bug...
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
id: steps
68+
attributes:
69+
label: Steps to Reproduce
70+
description: Steps to reproduce the behavior
71+
placeholder: |
72+
1. Go to '...'
73+
2. Click on '....'
74+
3. Scroll down to '....'
75+
4. See error
76+
validations:
77+
required: true
78+
79+
- type: textarea
80+
id: expected
81+
attributes:
82+
label: Expected Behavior
83+
description: What you expected to happen
84+
placeholder: Describe what should happen...
85+
validations:
86+
required: true
87+
88+
- type: textarea
89+
id: actual
90+
attributes:
91+
label: Actual Behavior
92+
description: What actually happened
93+
placeholder: Describe what actually happened...
94+
validations:
95+
required: true
96+
97+
- type: textarea
98+
id: environment
99+
attributes:
100+
label: Environment
101+
description: Environment details
102+
placeholder: |
103+
- OS: [e.g., macOS 14.0, Ubuntu 22.04]
104+
- Python version: [e.g., 3.12.11]
105+
- Vision Agents version: [e.g., 0.1.0]
106+
- Plugin versions: [e.g., openai-plugin 0.1.0]
107+
validations:
108+
required: true
109+
110+
- type: textarea
111+
id: code
112+
attributes:
113+
label: Code Sample
114+
description: Minimal code to reproduce the issue
115+
render: python
116+
placeholder: |
117+
```python
118+
# Your code here
119+
```
120+
validations:
121+
required: false
122+
123+
- type: textarea
124+
id: logs
125+
attributes:
126+
label: Error Logs
127+
description: Relevant error messages or logs
128+
render: shell
129+
placeholder: |
130+
```
131+
Paste error logs here
132+
```
133+
validations:
134+
required: false
135+
136+
- type: textarea
137+
id: additional
138+
attributes:
139+
label: Additional Context
140+
description: Any other context about the problem
141+
placeholder: Add any other context about the problem here...
142+
validations:
143+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 Discord Community
4+
url: https://discord.gg/RkhX9PxMS6
5+
about: Join our Discord community for discussions and support
6+
- name: 📚 Documentation
7+
url: https://visionagents.ai
8+
about: Check our documentation for guides and API reference
9+
- name: 🐛 Bug Reports
10+
url: https://github.com/GetStream/Vision-Agents/issues/new?template=bug_report.yml
11+
about: Report a bug or unexpected behavior
12+
- name: ✨ Feature Requests
13+
url: https://github.com/GetStream/Vision-Agents/issues/new?template=feature_request.yml
14+
about: Suggest a new feature or enhancement

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
name: ✨ Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "[Feature]: "
4+
labels: ["enhancement", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a new feature! Please fill out the form below to help us understand your request.
10+
11+
- type: dropdown
12+
id: component
13+
attributes:
14+
label: Component
15+
description: Which component would this feature affect?
16+
options:
17+
- Core Agent
18+
- LLM Integration
19+
- STT (Speech-to-Text)
20+
- TTS (Text-to-Speech)
21+
- Video Processing
22+
- Audio Processing
23+
- Plugin System
24+
- Edge/Stream Integration
25+
- Examples
26+
- Documentation
27+
- New Plugin
28+
- Other
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: feature
34+
attributes:
35+
label: Feature Description
36+
description: A clear and concise description of the feature you'd like to see
37+
placeholder: Describe the feature...
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: problem
43+
attributes:
44+
label: Problem Statement
45+
description: What problem does this feature solve?
46+
placeholder: Describe the problem this feature would solve...
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: solution
52+
attributes:
53+
label: Proposed Solution
54+
description: Describe your proposed solution
55+
placeholder: Describe how you think this feature should work...
56+
validations:
57+
required: true
58+
59+
- type: textarea
60+
id: alternatives
61+
attributes:
62+
label: Alternative Solutions
63+
description: Any alternative solutions or workarounds you've considered
64+
placeholder: Describe any alternatives you've considered...
65+
validations:
66+
required: false
67+
68+
- type: textarea
69+
id: use_cases
70+
attributes:
71+
label: Use Cases
72+
description: Describe specific use cases for this feature
73+
placeholder: |
74+
1. Use case 1
75+
2. Use case 2
76+
3. Use case 3
77+
validations:
78+
required: true
79+
80+
- type: textarea
81+
id: code
82+
attributes:
83+
label: Code Example
84+
description: If you have ideas for the API, show us how it might look
85+
render: python
86+
placeholder: |
87+
```python
88+
# Example of how the feature might be used
89+
```
90+
validations:
91+
required: false
92+
93+
- type: checkboxes
94+
id: impact
95+
attributes:
96+
label: Impact Assessment
97+
description: What would this feature impact?
98+
options:
99+
- label: Breaking change to existing API
100+
required: false
101+
- label: New plugin required
102+
required: false
103+
- label: Documentation updates needed
104+
required: false
105+
- label: Example updates needed
106+
required: false
107+
- label: Performance implications
108+
required: false
109+
110+
- type: textarea
111+
id: additional
112+
attributes:
113+
label: Additional Context
114+
description: Any other context, mockups, or references
115+
placeholder: Add any other context, screenshots, or references here...
116+
validations:
117+
required: false

0 commit comments

Comments
 (0)