Skip to content

Commit 220b630

Browse files
committed
feat: add GitHub issue templates for bug reports and feature requests
1 parent 3b02cd9 commit 220b630

File tree

3 files changed

+184
-0
lines changed

3 files changed

+184
-0
lines changed
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
name: Bug Report
2+
description: Report a bug or issue with the M-Lab Speed Test
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the following information to help us resolve the issue.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Bug Description
15+
description: A clear and concise description of what the bug is.
16+
placeholder: Describe the bug...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: steps
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Steps to reproduce the behavior
25+
placeholder: |
26+
1. Go to '...'
27+
2. Click on '...'
28+
3. Scroll down to '...'
29+
4. See error
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: expected
35+
attributes:
36+
label: Expected Behavior
37+
description: What you expected to happen
38+
placeholder: Describe what should happen...
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: actual
44+
attributes:
45+
label: Actual Behavior
46+
description: What actually happened
47+
placeholder: Describe what actually happened...
48+
validations:
49+
required: true
50+
51+
- type: dropdown
52+
id: browser
53+
attributes:
54+
label: Browser
55+
description: Which browser are you using?
56+
options:
57+
- Chrome
58+
- Firefox
59+
- Safari
60+
- Edge
61+
- Opera
62+
- Other
63+
validations:
64+
required: true
65+
66+
- type: input
67+
id: browser-version
68+
attributes:
69+
label: Browser Version
70+
description: What version of the browser are you using?
71+
placeholder: e.g., 120.0.6099.109
72+
validations:
73+
required: false
74+
75+
- type: dropdown
76+
id: os
77+
attributes:
78+
label: Operating System
79+
description: Which operating system are you using?
80+
options:
81+
- Windows
82+
- macOS
83+
- Linux
84+
- Android
85+
- iOS
86+
- Other
87+
validations:
88+
required: true
89+
90+
- type: textarea
91+
id: screenshots
92+
attributes:
93+
label: Screenshots
94+
description: If applicable, add screenshots to help explain your problem
95+
placeholder: Drag and drop images here or paste image URLs
96+
validations:
97+
required: false
98+
99+
- type: textarea
100+
id: additional
101+
attributes:
102+
label: Additional Context
103+
description: Add any other context about the problem here
104+
placeholder: Any additional information...
105+
validations:
106+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: M-Lab Support
4+
url: https://www.measurementlab.net/contact/
5+
about: For general M-Lab platform questions or support
6+
- name: Documentation
7+
url: https://github.com/m-lab/mlab-speedtest/blob/master/README.md
8+
about: Check the documentation for common questions and usage instructions
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement for M-Lab Speed Test
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a new feature! Please provide as much detail as possible.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem Statement
15+
description: Is your feature request related to a problem? Please describe.
16+
placeholder: I'm always frustrated when...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Proposed Solution
24+
description: Describe the solution you'd like
25+
placeholder: A clear and concise description of what you want to happen...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives Considered
33+
description: Describe any alternative solutions or features you've considered
34+
placeholder: Alternative approaches...
35+
validations:
36+
required: false
37+
38+
- type: dropdown
39+
id: feature-type
40+
attributes:
41+
label: Feature Type
42+
description: What type of feature is this?
43+
options:
44+
- UI/UX Enhancement
45+
- Performance Improvement
46+
- New Functionality
47+
- Accessibility
48+
- Localization/Translation
49+
- Documentation
50+
- Other
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: benefits
56+
attributes:
57+
label: Benefits
58+
description: Who would benefit from this feature and how?
59+
placeholder: Describe the benefits and impact...
60+
validations:
61+
required: false
62+
63+
- type: textarea
64+
id: additional
65+
attributes:
66+
label: Additional Context
67+
description: Add any other context, mockups, or screenshots about the feature request here
68+
placeholder: Any additional information...
69+
validations:
70+
required: false

0 commit comments

Comments
 (0)