Skip to content

Commit e8cd62d

Browse files
itsDNNSitsDNNS
authored
Update modem support issue template formatting
1 parent a620bbe commit e8cd62d

File tree

1 file changed

+65
-55
lines changed

1 file changed

+65
-55
lines changed

‎.github/ISSUE_TEMPLATE/modem_support.yml‎

Lines changed: 65 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
name: Modem Support Request
2-
description: Request support for a new cable modem model
3-
labels: ["modem support", "help wanted"]
1+
name: "Modem Support Request"
2+
description: "Request support for a new cable modem model"
3+
labels:
4+
- "modem support"
5+
- "help wanted"
6+
47
body:
58
- type: markdown
69
attributes:
@@ -15,113 +18,117 @@ name: Modem Support Request
1518
- type: input
1619
id: manufacturer
1720
attributes:
18-
label: Manufacturer
19-
description: Who makes the modem?
20-
placeholder: e.g., Arris, Technicolor, Netgear, Motorola
21+
label: "Manufacturer"
22+
description: "Who makes the modem?"
23+
placeholder: "e.g., Arris, Technicolor, Netgear, Motorola"
2124
validations:
2225
required: true
2326

2427
- type: input
2528
id: model
2629
attributes:
27-
label: Model Number
28-
description: Full model number (check the label on the device)
29-
placeholder: e.g., Arris TG3442DE, Netgear CM1000
30+
label: "Model Number"
31+
description: "Full model number (check the label on the device)"
32+
placeholder: "e.g., Arris TG3442DE, Netgear CM1000"
3033
validations:
3134
required: true
3235

3336
- type: input
3437
id: firmware
3538
attributes:
36-
label: Firmware Version
37-
description: Current firmware version (usually shown in the web interface)
38-
placeholder: e.g., 01.05.063.13.EURO.PC20
39+
label: "Firmware Version"
40+
description: "Current firmware version (usually shown in the web interface)"
41+
placeholder: "e.g., 01.05.063.13.EURO.PC20"
3942
validations:
4043
required: true
4144

4245
- type: input
4346
id: isp
4447
attributes:
45-
label: Internet Provider
46-
description: Which ISP provides this modem?
47-
placeholder: e.g., Vodafone Kabel, PYUR, Comcast
48+
label: "Internet Provider"
49+
description: "Which ISP provides this modem?"
50+
placeholder: "e.g., Vodafone Kabel, PYUR, Comcast"
4851

4952
- type: dropdown
5053
id: docsis
5154
attributes:
52-
label: DOCSIS Version
53-
description: Which DOCSIS standard does the modem support?
55+
label: "DOCSIS Version"
56+
description: "Which DOCSIS standard does the modem support?"
5457
options:
55-
- DOCSIS 3.0
56-
- DOCSIS 3.1
57-
- Don't know
58+
- "DOCSIS 3.0"
59+
- "DOCSIS 3.1"
60+
- "Don't know"
5861
validations:
5962
required: true
6063

6164
- type: input
6265
id: web_url
6366
attributes:
64-
label: Modem Web Interface URL
65-
description: What URL do you use to access the modem settings?
66-
placeholder: e.g., http://192.168.0.1 or http://192.168.100.1
67+
label: "Modem Web Interface URL"
68+
description: "What URL do you use to access the modem settings?"
69+
placeholder: "e.g., http://192.168.0.1 or http://192.168.100.1"
6770
validations:
6871
required: true
6972

7073
- type: dropdown
7174
id: authentication
7275
attributes:
73-
label: Authentication
74-
description: Does the web interface require login?
76+
label: "Authentication"
77+
description: "Does the web interface require login?"
7578
options:
76-
- Yes (username + password)
77-
- Yes (password only)
78-
- No authentication required
79+
- "Yes (username + password)"
80+
- "Yes (password only)"
81+
- "No authentication required"
7982
validations:
8083
required: true
8184

8285
- type: textarea
8386
id: screenshot
8487
attributes:
85-
label: DOCSIS Status Page Screenshot
88+
label: "DOCSIS Status Page Screenshot"
8689
description: |
8790
Upload a screenshot of the DOCSIS status page showing downstream/upstream channels.
8891
Redact any sensitive information (MAC address, IP, serial number).
89-
placeholder: Drag and drop a screenshot here
92+
placeholder: "Drag and drop a screenshot here"
9093
validations:
9194
required: true
9295

9396
- type: textarea
9497
id: har_file
9598
attributes:
96-
We need a HAR file to understand how your modem's web interface fetches data. Without this, we can't build a driver -- every modem and ISP firmware variant uses different API endpoints and
99+
label: "HAR File (Network Capture)"
100+
description: |
101+
We need a HAR file to understand how your modem's web interface fetches data. Without this, we can't build a driver because every modem and ISP firmware variant uses different API endpoints and
97102
authentication flows.
98103

99-
**How to capture:**
104+
How to capture:
100105
1. Close any already-open modem web UI tabs first
101106
2. Open Chrome or Firefox and open Developer Tools (F12) -> Network tab
102-
3. Start recording **before** opening the modem web interface
107+
3. Start recording before opening the modem web interface
103108
4. Open the modem web interface and log in from a clean browser tab
104-
5. Navigate to the DOCSIS status page (the page showing downstream/upstream channels)
105-
6. Right-click in the Network tab -> "Save all as HAR"
106-
7. **Important:** Verify that the HAR includes the actual login request/response flow, not only post-login data requests
107-
8. **Important:** Open the HAR file in a text editor and remove any passwords, MAC addresses, or serial numbers before uploading
108-
9. GitHub may reject raw `.har` uploads. If that happens, rename the file to `.har.txt` or upload it as a `.zip` archive instead
109+
5. Navigate to the DOCSIS status page
110+
6. Right-click in the Network tab and choose "Save all as HAR"
111+
7. Verify that the HAR includes the actual login request and response flow, not only post-login data requests
112+
8. Remove passwords, MAC addresses, or serial numbers before uploading
113+
9. If GitHub rejects raw `.har` uploads, rename the file to `.har.txt` or upload it as a `.zip` archive
109114
10. Upload the capture here
110115

111-
**Please make sure the capture includes:**
116+
Please make sure the capture includes:
112117
- The first request to the modem web UI
113-
- The login request itself (if authentication is required)
114-
- The first successful requests that load modem/channel data
115-
placeholder: Drag and drop .har.txt or .zip file here
118+
- The login request itself, if authentication is required
119+
- The first successful requests that load modem or channel data
120+
placeholder: "Drag and drop .har.txt or .zip file here"
116121
validations:
117122
required: true
118123

119124
- type: textarea
120125
id: session_behavior
121126
attributes:
122-
label: Login / Session Behavior
127+
label: "Login / Session Behavior"
123128
description: |
124129
Describe when the problem occurs and whether browser access affects it.
130+
placeholder: |
131+
Example:
125132
- Works on first login, fails on second test
126133
- Only fails after a poll cycle
127134
- Fails if the modem UI is open in a browser at the same time
@@ -130,39 +137,42 @@ name: Modem Support Request
130137
- type: textarea
131138
id: debug_logs
132139
attributes:
133-
label: Debug Logs (if login or polling fails)
140+
label: "Debug Logs (if login or polling fails)"
134141
description: |
135142
If the modem requires authentication or the issue involves failed logins, session expiry, or empty data, please also attach DOCSight debug logs from the same test window as the HAR capture.
136143
137144
Example:
138-
- Docker: `docker run ... -e LOG_LEVEL=DEBUG ...`
145+
- Docker: set `LOG_LEVEL=DEBUG`
139146
- Docker Compose: set `LOG_LEVEL=DEBUG` in the container environment
140-
placeholder: Paste relevant debug logs here or attach a .txt file
147+
placeholder: "Paste relevant debug logs here or attach a .txt file"
141148

142149
- type: textarea
143150
id: capture_conditions
144151
attributes:
145-
label: Capture Conditions
152+
label: "Capture Conditions"
146153
description: |
147-
Tell us how the HAR/logs were captured so we can reason about session state correctly.
154+
Tell us how the HAR and logs were captured so we can reason about session state correctly.
148155
placeholder: |
149156
Example:
150157
- Modem was freshly rebooted
151158
- No browser tabs to the modem UI were open
152159
- Browser login was done while DOCSight was polling
153160
- Captured on the first login after reboot
161+
162+
- type: checkboxes
163+
id: contribution
154164
attributes:
155-
label: I am willing to help
156-
description: Can you help with testing once we have a driver?
165+
label: "I am willing to help"
166+
description: "Can you help with testing once we have a driver?"
157167
options:
158-
- label: I can test the driver with my modem
168+
- label: "I can test the driver with my modem"
159169
required: false
160-
- label: I can provide additional debug logs if needed
170+
- label: "I can provide additional debug logs if needed"
161171
required: false
162172

163173
- type: textarea
164174
id: additional
165175
attributes:
166-
label: Additional Information
167-
description: Any other details that might help (known quirks, alternative access methods, etc.)
168-
placeholder: This modem also supports SNMP...
176+
label: "Additional Information"
177+
description: "Any other details that might help, such as quirks or alternative access methods"
178+
placeholder: "This modem also supports SNMP..."

0 commit comments

Comments
 (0)