Skip to content

Commit 7e0729c

Browse files
Merge pull request #21 from thetradedesk/add-github-issue-templates
Add GitHub issue templates
2 parents b76edfb + 271d8ce commit 7e0729c

4 files changed

Lines changed: 187 additions & 0 deletions

File tree

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: Bug Report
2+
description: Report a bug in the ttd-data SDK
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for reporting a bug! Please fill out the sections below so we can reproduce and fix the issue.
9+
10+
- type: input
11+
id: sdk-version
12+
attributes:
13+
label: ttd-data Version
14+
description: "Output of `pip show ttd-data`"
15+
placeholder: "e.g. 0.1.7"
16+
validations:
17+
required: true
18+
19+
- type: dropdown
20+
id: endpoint
21+
attributes:
22+
label: TTD Endpoint
23+
description: Which endpoint were you using?
24+
options:
25+
- /data/advertiser (First-Party Data)
26+
- /data/thirdparty (Third-Party Data)
27+
- /providerapi/offlineconversion (Offline Conversion)
28+
- /data/deletion-optout/advertiser
29+
- /data/deletion-optout/thirdparty
30+
- /data/deletion-optout/merchant
31+
- Not applicable
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: environment
37+
attributes:
38+
label: Environment
39+
description: Python version, OS, and any other relevant environment details
40+
placeholder: |
41+
- Python: 3.12
42+
- OS: Ubuntu 22.04
43+
- Install method: pip
44+
validations:
45+
required: true
46+
47+
- type: dropdown
48+
id: regression
49+
attributes:
50+
label: Did this work before?
51+
options:
52+
- "Yes, it was previously working"
53+
- "No, this never worked"
54+
- "Not sure"
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
id: description
60+
attributes:
61+
label: Describe the Bug
62+
placeholder: "A clear and concise description of what went wrong."
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
id: reproduction
68+
attributes:
69+
label: Steps to Reproduce
70+
placeholder: Minimal code snippet or steps to trigger the bug.
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: expected
76+
attributes:
77+
label: Expected Behavior
78+
placeholder: What you expected to happen.
79+
validations:
80+
required: true
81+
82+
- type: textarea
83+
id: actual
84+
attributes:
85+
label: Actual Behavior
86+
placeholder: What actually happened. Include the full traceback if applicable.
87+
validations:
88+
required: true
89+
90+
- type: textarea
91+
id: additional
92+
attributes:
93+
label: Additional Context
94+
placeholder: Any other context — screenshots, logs, related issues, workarounds tried.
95+
validations:
96+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: TTD Data API Documentation
4+
url: https://partner.thetradedesk.com/v3/portal/data/doc/DataApiReferenceIntegration
5+
about: Official TTD Data API docs for endpoint reference and authentication.
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Feature Request
2+
description: Suggest an enhancement or new capability
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
We appreciate feature suggestions! Please describe the problem you're facing and the feature request in detail.
9+
10+
- type: textarea
11+
id: problem
12+
attributes:
13+
label: Problem Statement
14+
placeholder: What problem does this feature solve? What workflow is painful today?
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
id: solution
20+
attributes:
21+
label: Proposed Solution
22+
placeholder: Describe how you'd like this to work. Code snippets showing your ideal API are welcome.
23+
validations:
24+
required: false
25+
26+
- type: textarea
27+
id: alternatives
28+
attributes:
29+
label: Alternatives Considered
30+
placeholder: What workarounds or alternative approaches have you tried or considered?
31+
validations:
32+
required: false
33+
34+
- type: dropdown
35+
id: scope
36+
attributes:
37+
label: Affected Area
38+
multiple: true
39+
options:
40+
- Client / Authentication
41+
- Data Ingestion (advertiser, third-party, offline conversion)
42+
- Deletion / Opt-Out
43+
- Error Handling
44+
- Documentation
45+
- Other
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
id: additional
51+
attributes:
52+
label: Additional Context
53+
placeholder: Any other context, screenshots, or references.
54+
validations:
55+
required: false
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Question
2+
description: Ask a question about SDK usage or behavior
3+
labels: ["question"]
4+
body:
5+
- type: checkboxes
6+
id: prerequisites
7+
attributes:
8+
label: Before submitting a question, please ensure you have checked the following
9+
options:
10+
- label: I have read the [ttd-data SDK README](https://github.com/thetradedesk/ttd-data-python#readme)
11+
required: true
12+
- label: I have read the [TTD Data API Documentation](https://partner.thetradedesk.com/v3/portal/data/doc/DataApiReferenceIntegration)
13+
required: true
14+
- label: I have searched existing [issues](https://github.com/thetradedesk/ttd-data-python/issues)
15+
required: true
16+
17+
- type: textarea
18+
id: question
19+
attributes:
20+
label: Question
21+
placeholder: Please provide a clear and concise description of the issue you are facing.
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: context
27+
attributes:
28+
label: Context
29+
placeholder: SDK version, endpoint, code snippet, or anything else that helps us understand your question.
30+
validations:
31+
required: false

0 commit comments

Comments
 (0)