Skip to content

Commit 10969b8

Browse files
committed
chore: add GitHub issue templates for Epic, Feature, and Bug reports
- Add comprehensive Epic template with sprint planning and technical architecture - Add Feature template with implementation guide and testing strategy - Add Bug template with environment details and regression analysis - All templates include area/component labeling for project organization - Templates follow existing VoidRunner issue patterns and requirements Signed-off-by: Zespre Schmidt <starbops@zespre.com>
1 parent d4e962f commit 10969b8

3 files changed

Lines changed: 814 additions & 0 deletions

File tree

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 273 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,273 @@
1+
name: Bug Report
2+
description: Report a bug or issue in VoidRunner
3+
title: "[Bug]: [Brief description of the issue]"
4+
labels:
5+
- "type/bug"
6+
body:
7+
- type: dropdown
8+
id: priority
9+
attributes:
10+
label: Priority
11+
description: Bug priority/severity level
12+
options:
13+
- "priority/0 (Critical - System down, security issue)"
14+
- "priority/1 (High - Major functionality broken)"
15+
- "priority/2 (Medium - Minor functionality issue)"
16+
validations:
17+
required: true
18+
19+
- type: checkboxes
20+
id: area_labels
21+
attributes:
22+
label: Affected Areas
23+
description: Select all areas affected by this bug
24+
options:
25+
- label: "area/api - REST API endpoints and middleware"
26+
- label: "area/frontend - Svelte UI components and pages"
27+
- label: "area/execution - Container execution and task processing"
28+
- label: "area/scheduler - Task queue management and prioritization"
29+
- label: "area/security - Authentication, authorization, and security controls"
30+
- label: "area/database - PostgreSQL schema, queries, and migrations"
31+
- label: "area/logging - Log collection, storage, and streaming"
32+
- label: "area/infra - Infrastructure, deployment, and configuration"
33+
34+
- type: checkboxes
35+
id: component_labels
36+
attributes:
37+
label: Affected Components
38+
description: Select all components affected by this bug
39+
options:
40+
- label: "component/auth - Authentication and authorization"
41+
- label: "component/scheduler - Task scheduling and queue management"
42+
- label: "component/docker - Docker integration and container management"
43+
- label: "component/logging - Log streaming and aggregation"
44+
- label: "component/monitoring - Metrics, alerting, and observability"
45+
- label: "component/k8s - Kubernetes manifests and configuration"
46+
- label: "component/database - Database operations and management"
47+
48+
- type: textarea
49+
id: bug_description
50+
attributes:
51+
label: Bug Description
52+
description: Provide a clear and concise description of what the bug is
53+
placeholder: "The system fails to..."
54+
validations:
55+
required: true
56+
57+
- type: textarea
58+
id: steps_to_reproduce
59+
attributes:
60+
label: Steps to Reproduce
61+
description: Detailed steps to reproduce the behavior
62+
value: |
63+
1. Go to '...'
64+
2. Click on '...'
65+
3. Execute command `...`
66+
4. See error
67+
validations:
68+
required: true
69+
70+
- type: textarea
71+
id: expected_behavior
72+
attributes:
73+
label: Expected Behavior
74+
description: What you expected to happen
75+
placeholder: "The system should..."
76+
validations:
77+
required: true
78+
79+
- type: textarea
80+
id: actual_behavior
81+
attributes:
82+
label: Actual Behavior
83+
description: What actually happened
84+
placeholder: "Instead, the system..."
85+
validations:
86+
required: true
87+
88+
- type: textarea
89+
id: error_logs
90+
attributes:
91+
label: Error Logs
92+
description: Relevant error messages, stack traces, or log output
93+
placeholder: |
94+
```
95+
Paste error logs here
96+
```
97+
validations:
98+
required: false
99+
100+
- type: textarea
101+
id: environment
102+
attributes:
103+
label: Environment
104+
description: Information about your environment
105+
value: |
106+
**Deployment Environment:**
107+
- [ ] Local development
108+
- [ ] Docker container
109+
- [ ] Kubernetes cluster
110+
- [ ] Production
111+
112+
**Operating System:**
113+
- [ ] Linux (specify distro/version)
114+
- [ ] macOS (specify version)
115+
- [ ] Windows (specify version)
116+
117+
**Browser (if frontend issue):**
118+
- [ ] Chrome (version)
119+
- [ ] Firefox (version)
120+
- [ ] Safari (version)
121+
- [ ] Edge (version)
122+
123+
**VoidRunner Version/Commit:**
124+
**Go Version:**
125+
**Docker Version:**
126+
**Kubernetes Version:**
127+
validations:
128+
required: true
129+
130+
- type: textarea
131+
id: reproduction_data
132+
attributes:
133+
label: Reproduction Data
134+
description: Sample data, configurations, or minimal reproduction case
135+
value: |
136+
## Sample Task/Configuration
137+
```json
138+
{
139+
"name": "test-task",
140+
"script_content": "print('hello')",
141+
"script_type": "python"
142+
}
143+
```
144+
145+
## Configuration Files
146+
```yaml
147+
# Relevant config snippets
148+
```
149+
150+
## Database State (if relevant)
151+
```sql
152+
-- Sample data that causes the issue
153+
```
154+
validations:
155+
required: false
156+
157+
- type: textarea
158+
id: screenshots
159+
attributes:
160+
label: Screenshots/Videos
161+
description: If applicable, add screenshots or videos to help explain the problem
162+
placeholder: "Drag and drop images/videos here or paste links"
163+
validations:
164+
required: false
165+
166+
- type: dropdown
167+
id: frequency
168+
attributes:
169+
label: Frequency
170+
description: How often does this bug occur?
171+
options:
172+
- "Always (100%)"
173+
- "Often (75-99%)"
174+
- "Sometimes (25-74%)"
175+
- "Rarely (1-24%)"
176+
- "Once (unable to reproduce)"
177+
validations:
178+
required: true
179+
180+
- type: textarea
181+
id: impact_assessment
182+
attributes:
183+
label: Impact Assessment
184+
description: How does this bug affect users and the system?
185+
value: |
186+
**User Impact:**
187+
- [ ] Blocks critical workflow
188+
- [ ] Degrades performance
189+
- [ ] Causes data loss
190+
- [ ] Security vulnerability
191+
- [ ] Cosmetic issue only
192+
193+
**Business Impact:**
194+
- [ ] Production system down
195+
- [ ] Customer complaints
196+
- [ ] Development team blocked
197+
- [ ] Minor inconvenience
198+
199+
**Affected Users:**
200+
- Number of users affected:
201+
- User types affected: [all users/admin users/specific role]
202+
validations:
203+
required: true
204+
205+
- type: textarea
206+
id: workaround
207+
attributes:
208+
label: Workaround
209+
description: Any temporary workaround that can be used
210+
placeholder: |
211+
If you've found a way to work around this issue temporarily, please describe it here.
212+
213+
Example:
214+
1. Use alternative endpoint X instead of Y
215+
2. Restart service Z to clear the issue
216+
3. Manually run command ABC
217+
validations:
218+
required: false
219+
220+
- type: textarea
221+
id: investigation_notes
222+
attributes:
223+
label: Investigation Notes
224+
description: Any debugging or investigation you've already done
225+
value: |
226+
## Already Tried
227+
- [ ] Checked logs for errors
228+
- [ ] Verified configuration
229+
- [ ] Tested in different environment
230+
- [ ] Searched existing issues
231+
232+
## Potential Root Cause
233+
[If you have theories about what might be causing this]
234+
235+
## Related Code/Components
236+
[Point to specific files, functions, or components that might be involved]
237+
validations:
238+
required: false
239+
240+
- type: textarea
241+
id: fix_suggestions
242+
attributes:
243+
label: Suggested Fix (Optional)
244+
description: If you have ideas for how to fix this bug
245+
placeholder: |
246+
If you have suggestions for how this could be fixed:
247+
248+
1. Potential solution approach
249+
2. Code changes needed
250+
3. Configuration updates required
251+
4. Testing strategy for the fix
252+
validations:
253+
required: false
254+
255+
- type: checkboxes
256+
id: regression
257+
attributes:
258+
label: Regression Analysis
259+
description: Help us understand if this is a regression
260+
options:
261+
- label: "This worked in a previous version"
262+
- label: "This is a new feature that never worked"
263+
- label: "This worked in a different environment"
264+
- label: "This issue appeared after a recent deployment"
265+
266+
- type: input
267+
id: regression_version
268+
attributes:
269+
label: Last Working Version
270+
description: If this is a regression, what was the last version where this worked?
271+
placeholder: "v1.2.3 or commit hash abc123"
272+
validations:
273+
required: false

0 commit comments

Comments
 (0)