Skip to content

Commit 4d96767

Browse files
lukeocodeslukeocodes
committed
chore: configuring release-please
1 parent 2ada769 commit 4d96767

File tree

10 files changed

+463
-73
lines changed

10 files changed

+463
-73
lines changed

‎.github/.release-please-manifest.json‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎.github/CODEOWNERS‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Global code owners - these users will be requested for review on all API SPEC PRs
2+
# DX TEAM Members
3+
* @lukeocodes
4+
5+
# Future Reference: you can also specify owners for specific paths if needed:
6+
# /src/ @username1 @username2

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 219 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,219 @@
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.v2 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. Install deepgram-sdk==5.0.0
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: python
52+
placeholder: |
53+
from deepgram import Deepgram
54+
# minimal snippet here
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
id: logs
60+
attributes:
61+
label: Logs / traceback
62+
description: Full stack trace or error message (best with DEBUG logs)
63+
render: text
64+
placeholder: |
65+
Traceback (most recent call last):
66+
...
67+
validations:
68+
required: false
69+
70+
- type: dropdown
71+
id: transport
72+
attributes:
73+
label: Transport
74+
options:
75+
- HTTP
76+
- WebSocket
77+
- Both / Not sure
78+
validations:
79+
required: true
80+
81+
- type: input
82+
id: endpoint
83+
attributes:
84+
label: API endpoint / path
85+
placeholder: "/v1/listen/… or /v1/speak/…"
86+
validations:
87+
required: true
88+
89+
- type: input
90+
id: model
91+
attributes:
92+
label: Model(s) used
93+
placeholder: "nova-2, aura-asteria-en, etc."
94+
validations:
95+
required: false
96+
97+
- type: dropdown
98+
id: repro_rate
99+
attributes:
100+
label: How often?
101+
options:
102+
- Always
103+
- Often
104+
- Sometimes
105+
- Rarely
106+
- Only once
107+
validations:
108+
required: true
109+
110+
- type: checkboxes
111+
id: regression
112+
attributes:
113+
label: Is this a regression?
114+
options:
115+
- label: "Yes, it worked in an earlier version"
116+
required: false
117+
118+
- type: input
119+
id: worked_version
120+
attributes:
121+
label: Last working SDK version (if known)
122+
placeholder: "4.8.1"
123+
validations:
124+
required: false
125+
126+
- type: input
127+
id: sdk_version
128+
attributes:
129+
label: SDK version
130+
placeholder: "5.0.0"
131+
validations:
132+
required: true
133+
134+
- type: input
135+
id: python_version
136+
attributes:
137+
label: Python version
138+
placeholder: "3.10.14"
139+
validations:
140+
required: true
141+
142+
- type: dropdown
143+
id: install_method
144+
attributes:
145+
label: Install method
146+
options:
147+
- pip
148+
- pipx
149+
- Poetry
150+
- uv
151+
- Conda
152+
- From source
153+
validations:
154+
required: false
155+
156+
- type: dropdown
157+
id: os
158+
attributes:
159+
label: OS
160+
multiple: true
161+
options:
162+
- macOS (Intel)
163+
- macOS (Apple Silicon)
164+
- Linux (x86_64)
165+
- Linux (arm64)
166+
- Windows
167+
- Other
168+
validations:
169+
required: true
170+
171+
- type: textarea
172+
id: extra_env
173+
attributes:
174+
label: Environment details
175+
description: Anything else? Docker, Fly.io, proxies, corporate network, etc.
176+
render: text
177+
validations:
178+
required: false
179+
180+
- type: input
181+
id: repro_repo
182+
attributes:
183+
label: Link to minimal repro (optional)
184+
placeholder: "https://github.com/yourname/repro"
185+
validations:
186+
required: false
187+
188+
- type: input
189+
id: session_id
190+
attributes:
191+
label: Session ID (optional)
192+
placeholder: "123e4567-e89b-12d3-a456-426614174000"
193+
validations:
194+
required: false
195+
196+
- type: input
197+
id: project_id
198+
attributes:
199+
label: Project ID (optional)
200+
placeholder: "proj_abc123"
201+
validations:
202+
required: false
203+
204+
- type: input
205+
id: request_id
206+
attributes:
207+
label: Request ID (optional)
208+
description: From API error messages or response headers (`x-dg-request-id`)
209+
placeholder: "req_def456"
210+
validations:
211+
required: false
212+
213+
- type: checkboxes
214+
id: conduct
215+
attributes:
216+
label: Code of Conduct
217+
options:
218+
- label: I agree to follow this project’s Code of Conduct
219+
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://docs.example.com/python/…"
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 5.0.0"
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 Python 3.12…"
28+
validations:
29+
required: false
30+
31+
- type: textarea
32+
id: example
33+
attributes:
34+
label: Example code (if any)
35+
render: python
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

0 commit comments

Comments
 (0)