Skip to content

Commit 40dbb5e

Browse files
committed
chore: add issue templates
1 parent 06351c0 commit 40dbb5e

File tree

5 files changed

+629
-0
lines changed

5 files changed

+629
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug or unexpected behavior
3+
title: "[BUG] "
4+
labels: ["bug", "needs-triage"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## 🐛 Bug Report
11+
Thanks for taking the time to report a bug! Please provide detailed information to help us reproduce and fix the issue.
12+
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: 📋 Bug Description
17+
description: A clear and concise description of the bug.
18+
placeholder: "Describe what the bug is..."
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: expected_behavior
24+
attributes:
25+
label: ✅ Expected Behavior
26+
description: What did you expect to happen?
27+
placeholder: "I expected..."
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: actual_behavior
33+
attributes:
34+
label: ❌ Actual Behavior
35+
description: What actually happened instead?
36+
placeholder: "Instead, what happened was..."
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: steps_to_reproduce
42+
attributes:
43+
label: 🔄 Steps to Reproduce
44+
description: Please provide detailed steps to reproduce the behavior
45+
placeholder: |
46+
1. Go to '...'
47+
2. Click on '...'
48+
3. Scroll down to '...'
49+
4. See error
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: environment
55+
attributes:
56+
label: 🌍 Environment
57+
description: Please provide information about your environment
58+
placeholder: |
59+
- OS: [e.g. macOS 14.1, Windows 11, Ubuntu 22.04]
60+
- Browser: [e.g. Chrome 120, Firefox 121, Safari 17]
61+
- Node.js version: [e.g. 18.17.0]
62+
- Package version: [e.g. 1.2.3]
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
id: error_logs
68+
attributes:
69+
label: 📜 Error Logs/Console Output
70+
description: Please paste any relevant error messages or console output
71+
placeholder: "Paste error logs here..."
72+
render: shell
73+
validations:
74+
required: false
75+
76+
- type: textarea
77+
id: minimal_reproduction
78+
attributes:
79+
label: 🔬 Minimal Reproduction Case
80+
description: If possible, provide a minimal code example that reproduces the issue
81+
placeholder: "Minimal code example..."
82+
render: javascript
83+
validations:
84+
required: false
85+
86+
- type: dropdown
87+
id: severity
88+
attributes:
89+
label: 🚨 Severity Level
90+
description: How severe is this bug?
91+
options:
92+
- Low - Minor issue, workaround available
93+
- Medium - Affects functionality but not critical
94+
- High - Significant impact on functionality
95+
- Critical - Complete failure, no workaround
96+
validations:
97+
required: true
98+
99+
- type: dropdown
100+
id: frequency
101+
attributes:
102+
label: 🔄 Frequency
103+
description: How often does this bug occur?
104+
options:
105+
- Once - Happened only once
106+
- Occasionally - Happens sometimes
107+
- Frequently - Happens often
108+
- Always - Happens every time
109+
validations:
110+
required: true
111+
112+
- type: checkboxes
113+
id: regression
114+
attributes:
115+
label: 📈 Regression Check
116+
description: Is this a regression from a previous version?
117+
options:
118+
- label: This is a regression (it worked in a previous version)
119+
- label: This affects multiple versions
120+
- label: This is a new issue
121+
122+
- type: checkboxes
123+
id: definition_of_done
124+
attributes:
125+
label: ✅ Definition of Done
126+
description: Check all criteria that should be met for this bug to be considered fixed
127+
options:
128+
- label: Bug reproduced and root cause identified
129+
- label: Fix implemented and tested
130+
- label: Regression tests added to prevent future occurrences
131+
- label: Fix verified in affected environments
132+
- label: Documentation updated if needed
133+
- label: Code reviewed and approved
134+
- label: Performance impact assessed
135+
- label: Related bugs checked and addressed
136+
137+
- type: textarea
138+
id: workaround
139+
attributes:
140+
label: 🛠️ Workaround
141+
description: Have you found any workaround for this issue?
142+
placeholder: "Temporary workaround (if any)..."
143+
validations:
144+
required: false
145+
146+
- type: textarea
147+
id: additional_context
148+
attributes:
149+
label: 📎 Additional Context
150+
description: Add any other context about the problem here (screenshots, related issues, etc.)
151+
placeholder: "Any additional information..."
152+
validations:
153+
required: false
154+
155+
- type: markdown
156+
attributes:
157+
value: |
158+
---
159+
**For AI Agents (Copilot/Cursor):** This bug report contains structured information including reproduction steps, environment details, and expected vs actual behavior. Use the severity and frequency to prioritize the fix. The Definition of Done provides clear resolution criteria.

.github/ISSUE_TEMPLATE/chore.yml

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
name: 🔧 Chore
2+
description: Maintenance tasks, refactoring, or technical improvements
3+
title: "[CHORE] "
4+
labels: ["chore", "maintenance"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## 🔧 Chore
11+
Thanks for identifying a maintenance task! Please provide details about the work needed to keep our codebase healthy and efficient.
12+
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: 📋 Description
17+
description: Provide a clear description of the maintenance task or improvement needed.
18+
placeholder: "Describe the chore/maintenance task..."
19+
validations:
20+
required: true
21+
22+
- type: dropdown
23+
id: category
24+
attributes:
25+
label: 📂 Category
26+
description: What type of chore is this?
27+
options:
28+
- Code Refactoring - Improve code structure/quality
29+
- Dependency Updates - Update packages/libraries
30+
- Performance Optimization - Improve speed/efficiency
31+
- Code Cleanup - Remove unused code/comments
32+
- Build/CI Improvements - Improve build process
33+
- Testing Infrastructure - Improve test setup/coverage
34+
- Documentation Maintenance - Update/fix docs
35+
- Security Updates - Address security concerns
36+
- Configuration Changes - Update settings/config
37+
- Tooling Improvements - Improve developer tools
38+
- Other - Specify in description
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: motivation
44+
attributes:
45+
label: 🎯 Motivation
46+
description: Why is this chore necessary? What problem does it solve or what improvement does it provide?
47+
placeholder: "This is needed because..."
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: scope
53+
attributes:
54+
label: 🎌 Scope of Work
55+
description: What specific areas of the codebase will be affected?
56+
placeholder: "Files/modules/components that will be modified..."
57+
validations:
58+
required: true
59+
60+
- type: dropdown
61+
id: impact
62+
attributes:
63+
label: 📊 Impact Level
64+
description: What is the expected impact of this chore?
65+
options:
66+
- Low - Minor improvements, no breaking changes
67+
- Medium - Noticeable improvements, minimal risk
68+
- High - Significant improvements, some risk
69+
- Critical - Major changes, needs careful planning
70+
validations:
71+
required: true
72+
73+
- type: dropdown
74+
id: urgency
75+
attributes:
76+
label: ⏰ Urgency
77+
description: How urgent is this maintenance task?
78+
options:
79+
- Low - Can be done when time permits
80+
- Medium - Should be done in next sprint
81+
- High - Should be done soon
82+
- Critical - Needs immediate attention
83+
validations:
84+
required: true
85+
86+
- type: textarea
87+
id: breaking_changes
88+
attributes:
89+
label: ⚠️ Breaking Changes
90+
description: Will this chore introduce any breaking changes? If so, describe them.
91+
placeholder: "Any breaking changes or migration steps..."
92+
validations:
93+
required: false
94+
95+
- type: textarea
96+
id: testing_strategy
97+
attributes:
98+
label: 🧪 Testing Strategy
99+
description: How will you ensure this chore doesn't break existing functionality?
100+
placeholder: "Testing approach and validation steps..."
101+
validations:
102+
required: false
103+
104+
- type: checkboxes
105+
id: definition_of_done
106+
attributes:
107+
label: ✅ Definition of Done
108+
description: Check all criteria that should be met for this chore to be considered complete
109+
options:
110+
- label: Changes implemented as described
111+
- label: Existing functionality verified unaffected
112+
- label: Tests updated and passing
113+
- label: Documentation updated if needed
114+
- label: Code reviewed and approved
115+
- label: Performance impact assessed
116+
- label: Breaking changes documented
117+
- label: Migration guide provided (if applicable)
118+
- label: Rollback plan prepared (if high risk)
119+
120+
- type: textarea
121+
id: dependencies
122+
attributes:
123+
label: 🔗 Dependencies
124+
description: Are there any dependencies or prerequisites for this chore?
125+
placeholder: "Dependencies on other issues, external factors, etc..."
126+
validations:
127+
required: false
128+
129+
- type: textarea
130+
id: timeline
131+
attributes:
132+
label: ⏱️ Estimated Timeline
133+
description: How long do you estimate this chore will take?
134+
placeholder: "Estimated time to complete..."
135+
validations:
136+
required: false
137+
138+
- type: textarea
139+
id: additional_context
140+
attributes:
141+
label: 📎 Additional Context
142+
description: Any other relevant information, links, or context.
143+
placeholder: "Links to related issues, documentation, or resources..."
144+
validations:
145+
required: false
146+
147+
- type: markdown
148+
attributes:
149+
value: |
150+
---
151+
**For AI Agents (Copilot/Cursor):** This chore contains structured information about maintenance work including scope, impact level, and testing strategy. Use the category and urgency to prioritize the work. The Definition of Done provides clear completion criteria for technical improvements.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 📖 Documentation
4+
url: https://github.com/vltpkg/statusboard/blob/main/README.md
5+
about: Check our documentation for guidance and information

0 commit comments

Comments
 (0)