Skip to content

Commit 319caed

Browse files
docs: unified fields for bug report template (hoppscotch#5174)
1 parent 8e5b44d commit 319caed

File tree

1 file changed

+101
-118
lines changed

1 file changed

+101
-118
lines changed
Lines changed: 101 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -1,134 +1,117 @@
1-
name: Bug report
1+
name: Bug Report
22
description: Create a bug report to help us improve Hoppscotch
33
title: "[bug]: "
44
labels: [bug, need testing]
55
body:
6-
- type: markdown
7-
attributes:
8-
value: |
9-
Thank you for taking the time to report this issue. Complete information helps us resolve issues faster.
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for taking the time to report this issue. Complete information helps us resolve it faster.
1010
11-
- type: checkboxes
12-
attributes:
13-
label: Is there an existing issue for this?
14-
description: Please search to see if an issue already exists for the bug you encountered
15-
options:
16-
- label: I have searched existing issues and this bug hasn't been reported yet
11+
- type: checkboxes
12+
attributes:
13+
label: Is there an existing issue for this?
14+
description: Please search to see if an issue already exists for the bug you encountered
15+
options:
16+
- label: I have searched existing issues and this bug hasn't been reported yet
17+
required: true
18+
19+
- type: dropdown
20+
id: platform
21+
attributes:
22+
label: Platform
23+
description: How are you accessing Hoppscotch?
24+
options:
25+
- Web App
26+
- Desktop App
27+
validations:
28+
required: true
29+
30+
- type: dropdown
31+
id: browser
32+
attributes:
33+
label: Browser
34+
description: |
35+
Which browser is affected?
36+
- For web app: Select the browser you're using
37+
- For desktop app: Select your default browser
38+
options:
39+
- Chrome
40+
- Firefox
41+
- Safari
42+
- Edge
43+
- Opera
44+
- Other (specify in additional info)
45+
validations:
1746
required: true
1847

19-
- type: textarea
20-
attributes:
21-
label: Current behavior
22-
description: A concise description of what you're experiencing and what you expect
23-
placeholder: |
24-
When I do <X>, <Y> happens and I see the error message attached below:
25-
```...```
26-
What I expect is <Z>
27-
validations:
28-
required: true
48+
- type: dropdown
49+
id: os
50+
attributes:
51+
label: Operating System
52+
description: Which operating system are you using?
53+
options:
54+
- Windows
55+
- macOS
56+
- Linux
57+
- Other (specify in additional info)
58+
validations:
59+
required: true
2960

30-
- type: textarea
31-
attributes:
32-
label: Steps to reproduce
33-
description: Add steps to reproduce this behaviour, include console or network logs and screenshots
34-
placeholder: |
35-
1. Go to '...'
36-
2. Click on '....'
37-
3. Scroll down to '....'
38-
4. See error
39-
validations:
40-
required: true
61+
- type: textarea
62+
attributes:
63+
label: Bug Description
64+
description: |
65+
Describe the bug, how to reproduce it, and any additional context that would help us fix it. Include screenshots when possible.
4166
42-
- type: textarea
43-
id: logs
44-
attributes:
45-
label: Logs and Screenshots
46-
description: Include any relevant anonymized console logs, network errors, or screenshots
47-
placeholder: |
48-
```
49-
Uncaught TypeError: Cannot read property 'data' of undefined
50-
at GraphQLModule.processResponse (graphql.js:242)
51-
```
67+
**For request-related issues:** Please specify which interceptor you're using (Browser, Agent, Extension, Proxy, Native, etc.)
68+
placeholder: |
69+
## What happened?
70+
When I do <X>, <Y> happens and I see the error:
71+
```
72+
[paste error message here]
73+
```
74+
What I expected is <Z>
5275
53-
[Attach screenshots if available]
54-
render: shell
76+
## Steps to reproduce
77+
1. Go to '...'
78+
2. Click on '....'
79+
3. See error
5580
56-
- type: dropdown
57-
id: env
58-
attributes:
59-
label: Environment
60-
description: Where did you encounter this issue?
61-
options:
62-
- Production
63-
- Release
64-
- Deploy preview
65-
validations:
66-
required: true
81+
## Screenshots
82+
[Attach screenshots here if available - they're really helpful!]
6783
68-
- type: dropdown
69-
id: version
70-
attributes:
71-
label: Hoppscotch Version
72-
description: Which version of Hoppscotch are you using?
73-
options:
74-
- Cloud
75-
- Self-hosted
76-
- Local
77-
validations:
78-
required: true
84+
## Additional context
85+
Interceptor used (if request-related): [Browser/Agent/Extension/Proxy/Native/etc.]
7986
80-
- type: dropdown
81-
id: interceptor
82-
attributes:
83-
label: Interceptor
84-
description: Which request interceptor are you using? (Select "Not Applicable" if your issue isn't related to network requests)
85-
options:
86-
- Not Applicable - Issue not related to network requests
87-
- Browser - Web App
88-
- Agent - Web App
89-
- Extension - Web App
90-
- Proxy - Web App
91-
- Native - Desktop App
92-
- Proxy - Desktop App
93-
default: 0
94-
validations:
95-
required: true
87+
## Logs and Console Output (if available)
88+
```
89+
Paste any relevant logs here
90+
```
9691
97-
- type: dropdown
98-
id: browsers
99-
attributes:
100-
label: Browsers Affected
101-
description: Which browsers have you seen this issue on? (Select all that apply)
102-
multiple: true
103-
options:
104-
- Chrome
105-
- Firefox
106-
- Safari
107-
- Edge
108-
- Opera
109-
- Other (specify in additional info)
110-
- Not browser-specific
111-
- Not applicable (Desktop app)
92+
## Additional details (if relevant)
93+
- Device specifics:
94+
- Special configurations:
95+
validations:
96+
required: true
11297

113-
- type: dropdown
114-
id: os
115-
attributes:
116-
label: Operating System
117-
description: Which operating system are you using?
118-
options:
119-
- Windows
120-
- MacOS
121-
- Linux
122-
- Other (specify in additional info)
98+
- type: dropdown
99+
id: deployment
100+
attributes:
101+
label: Deployment Type
102+
description: What type of Hoppscotch deployment are you using?
103+
options:
104+
- Hoppscotch Cloud
105+
- Self-hosted (on-prem deployment)
106+
validations:
107+
required: true
123108

124-
- type: textarea
125-
id: additional
126-
attributes:
127-
label: Additional Information
128-
description: Any other details that might help us understand and fix the issue
129-
placeholder: |
130-
- Self Hosted instance version if not latest
131-
- Desktop app version if not latest
132-
- Device specifics
133-
- Special configurations
134-
- Context about your use case
109+
- type: input
110+
id: version
111+
attributes:
112+
label: Version
113+
description: |
114+
For Self-Hosted deployments: Specify your deployment version
115+
For Desktop App: Specify your app version
116+
validations:
117+
required: false

0 commit comments

Comments
 (0)