Skip to content

Commit dffbe78

Browse files
GregHolmesGregHolmes
authored
Merge pull request #7 from deepgram/add-issue-templates
chore: add issue templates for bug reports, features, and docs
2 parents 343e69d + 128e7d3 commit dffbe78

3 files changed

Lines changed: 388 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 218 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,218 @@
1+
name: "🐛 Bug report"
2+
description: Report something that is broken or crashes
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for filing a bug. Please give a **minimal** repro when you can.
11+
- type: input
12+
id: summary
13+
attributes:
14+
label: Summary
15+
description: Short one-liner of the problem
16+
placeholder: "Crash when calling client.listen().v1().v1WebSocket() from a thread"
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: what_happened
22+
attributes:
23+
label: What happened?
24+
description: Tell us what you saw and what you expected instead
25+
placeholder: |
26+
Actual:
27+
- …
28+
29+
Expected:
30+
- …
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: repro_steps
36+
attributes:
37+
label: Steps to reproduce
38+
description: Numbered steps; include inputs that matter (model, options, etc.)
39+
placeholder: |
40+
1. Add deepgram-java-sdk:0.0.1 to build.gradle
41+
2. Run the code below
42+
3. Observe error XYZ
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: code
48+
attributes:
49+
label: Minimal code sample
50+
description: Small, runnable example (trim secrets). Attach a gist/repo if easier.
51+
render: java
52+
placeholder: |
53+
DeepgramClient client = DeepgramClient.builder()
54+
.apiKey("your-key")
55+
.build();
56+
// minimal snippet here
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
id: logs
62+
attributes:
63+
label: Logs / stack trace
64+
description: Full stack trace or error message
65+
render: text
66+
placeholder: |
67+
Exception in thread "main" ...
68+
at ...
69+
validations:
70+
required: false
71+
72+
- type: dropdown
73+
id: transport
74+
attributes:
75+
label: Transport
76+
options:
77+
- HTTP
78+
- WebSocket
79+
- Both / Not sure
80+
validations:
81+
required: true
82+
83+
- type: input
84+
id: endpoint
85+
attributes:
86+
label: API endpoint / path
87+
placeholder: "/v1/listen/… or /v1/speak/…"
88+
validations:
89+
required: true
90+
91+
- type: input
92+
id: model
93+
attributes:
94+
label: Model(s) used
95+
placeholder: "nova-3, aura-2-asteria-en, flux-general-en, etc."
96+
validations:
97+
required: false
98+
99+
- type: dropdown
100+
id: repro_rate
101+
attributes:
102+
label: How often?
103+
options:
104+
- Always
105+
- Often
106+
- Sometimes
107+
- Rarely
108+
- Only once
109+
validations:
110+
required: true
111+
112+
- type: checkboxes
113+
id: regression
114+
attributes:
115+
label: Is this a regression?
116+
options:
117+
- label: "Yes, it worked in an earlier version"
118+
required: false
119+
120+
- type: input
121+
id: worked_version
122+
attributes:
123+
label: Last working SDK version (if known)
124+
placeholder: "0.0.1"
125+
validations:
126+
required: false
127+
128+
- type: input
129+
id: sdk_version
130+
attributes:
131+
label: SDK version
132+
placeholder: "0.0.1"
133+
validations:
134+
required: true
135+
136+
- type: input
137+
id: java_version
138+
attributes:
139+
label: Java version
140+
placeholder: "17.0.12"
141+
validations:
142+
required: true
143+
144+
- type: dropdown
145+
id: install_method
146+
attributes:
147+
label: Install method
148+
options:
149+
- Gradle
150+
- Maven
151+
- From source
152+
validations:
153+
required: false
154+
155+
- type: dropdown
156+
id: os
157+
attributes:
158+
label: OS
159+
multiple: true
160+
options:
161+
- macOS (Intel)
162+
- macOS (Apple Silicon)
163+
- Linux (x86_64)
164+
- Linux (arm64)
165+
- Windows
166+
- Other
167+
validations:
168+
required: true
169+
170+
- type: textarea
171+
id: extra_env
172+
attributes:
173+
label: Environment details
174+
description: Anything else? Docker, Spring Boot, Android, corporate network, etc.
175+
render: text
176+
validations:
177+
required: false
178+
179+
- type: input
180+
id: repro_repo
181+
attributes:
182+
label: Link to minimal repro (optional)
183+
placeholder: "https://github.com/yourname/repro"
184+
validations:
185+
required: false
186+
187+
- type: input
188+
id: session_id
189+
attributes:
190+
label: Session ID (optional)
191+
placeholder: "123e4567-e89b-12d3-a456-426614174000"
192+
validations:
193+
required: false
194+
195+
- type: input
196+
id: project_id
197+
attributes:
198+
label: Project ID (optional)
199+
placeholder: "proj_abc123"
200+
validations:
201+
required: false
202+
203+
- type: input
204+
id: request_id
205+
attributes:
206+
label: Request ID (optional)
207+
description: From API error messages or response headers (`dg-request-id`)
208+
placeholder: "req_def456"
209+
validations:
210+
required: false
211+
212+
- type: checkboxes
213+
id: conduct
214+
attributes:
215+
label: Code of Conduct
216+
options:
217+
- label: I agree to follow this project's Code of Conduct
218+
required: true

‎.github/ISSUE_TEMPLATE/docs_improvement.yml‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: "📚 Docs improvement"
2+
description: Fix or improve documentation, examples, or comments
3+
title: "[Docs]: "
4+
labels: ["documentation", "needs-triage"]
5+
body:
6+
- type: input
7+
id: page
8+
attributes:
9+
label: Affected page or section
10+
placeholder: "https://developers.deepgram.com/… or README.md"
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: issue
16+
attributes:
17+
label: What is unclear or wrong?
18+
placeholder: "Option X is outdated; code sample fails with 0.0.1"
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: suggestion
24+
attributes:
25+
label: Suggested change
26+
render: markdown
27+
placeholder: "Replace snippet with… Add note about Java 21…"
28+
validations:
29+
required: false
30+
31+
- type: textarea
32+
id: example
33+
attributes:
34+
label: Example code (if any)
35+
render: java
36+
placeholder: "// short snippet"
37+
validations:
38+
required: false
39+
40+
- type: checkboxes
41+
id: parity
42+
attributes:
43+
label: SDK parity (if relevant)
44+
options:
45+
- label: This change may need updates in other SDKs
46+
required: false
47+
48+
- type: input
49+
id: session_id
50+
attributes:
51+
label: Session ID (optional)
52+
placeholder: "123e4567-e89b-12d3-a456-426614174000"
53+
validations:
54+
required: false
55+
56+
- type: input
57+
id: project_id
58+
attributes:
59+
label: Project ID (optional)
60+
placeholder: "proj_abc123"
61+
validations:
62+
required: false
63+
64+
- type: input
65+
id: request_id
66+
attributes:
67+
label: Request ID (optional)
68+
description: From API error messages or response headers (`dg-request-id`)
69+
placeholder: "req_def456"
70+
validations:
71+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
name: "✨ Feature request"
2+
description: Suggest a new capability or API
3+
title: "[Feature]: "
4+
labels: ["enhancement", "needs-triage"]
5+
body:
6+
- type: input
7+
id: summary
8+
attributes:
9+
label: Summary
10+
placeholder: "Add async streaming helper for /v1/listen"
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: problem
16+
attributes:
17+
label: Problem to solve
18+
description: What user problem does this address?
19+
placeholder: "Today I need to write a lot of boilerplate to stream audio…"
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: proposal
25+
attributes:
26+
label: Proposed solution
27+
description: API shape, flags, defaults. Keep it simple.
28+
render: java
29+
placeholder: |
30+
// Example
31+
V1WebSocketClient ws = client.listen().v1().v1WebSocket();
32+
ws.connect(V1ConnectOptions.builder().model(ListenV1Model.NOVA3).build());
33+
ws.sendMedia(ByteString.of(audioBytes));
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: alternatives
39+
attributes:
40+
label: Alternatives considered
41+
placeholder: "Manual OkHttp WebSockets; third-party lib; do nothing"
42+
validations:
43+
required: false
44+
45+
- type: dropdown
46+
id: scope
47+
attributes:
48+
label: Scope
49+
options:
50+
- Java only
51+
- All SDKs (parity)
52+
- Docs/sample only
53+
validations:
54+
required: true
55+
56+
- type: dropdown
57+
id: priority
58+
attributes:
59+
label: Priority
60+
options:
61+
- Nice to have
62+
- Important
63+
- High impact
64+
- Blocker
65+
validations:
66+
required: false
67+
68+
- type: textarea
69+
id: context
70+
attributes:
71+
label: Extra context / links
72+
placeholder: "Related issues, forum threads, benchmarks, etc."
73+
validations:
74+
required: false
75+
76+
- type: input
77+
id: session_id
78+
attributes:
79+
label: Session ID (optional)
80+
placeholder: "123e4567-e89b-12d3-a456-426614174000"
81+
validations:
82+
required: false
83+
84+
- type: input
85+
id: project_id
86+
attributes:
87+
label: Project ID (optional)
88+
placeholder: "proj_abc123"
89+
validations:
90+
required: false
91+
92+
- type: input
93+
id: request_id
94+
attributes:
95+
label: Request ID (optional)
96+
description: From API error messages or response headers (`dg-request-id`)
97+
placeholder: "req_def456"
98+
validations:
99+
required: false

0 commit comments

Comments
 (0)
⚡