Skip to content

Commit 7053428

Browse files
authored
Add OAuth issue template
1 parent e64fa82 commit 7053428

1 file changed

Lines changed: 151 additions & 0 deletions

File tree

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
name: OAuth Issue
2+
description: Report an OAuth problem, ask for integration help, or suggest an OAuth improvement.
3+
title: "[OAuth]: "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to explain what you are running into. You do not need to know the OAuth terminology; describe what you saw in your own words and use **I'm not sure** where needed.
9+
10+
> Note: **Keep credentials private.** Do not include access or refresh tokens, authorization codes, client secrets, private keys, DPoP proofs, cookies, or complete `Authorization` headers. Replace them with `<redacted>` in code, URLs, screenshots, and logs.
11+
12+
- type: dropdown
13+
id: issue-type
14+
attributes:
15+
label: What do you need help with?
16+
description: Choose the option that comes closest. It does not need to be exact.
17+
options:
18+
- Something is not working
19+
- I need help integrating OAuth
20+
- The documentation is unclear or incomplete
21+
- I would like an OAuth improvement
22+
- I'm not sure
23+
validations:
24+
required: true
25+
26+
- type: input
27+
id: summary
28+
attributes:
29+
label: Summary
30+
description: In one or two sentences, what are you trying to do and what is getting in the way?
31+
placeholder: "After signing in, my app returns from the browser but ATProtoKit does not have an active session."
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: flow
37+
attributes:
38+
label: What happened?
39+
description: Walk through what you did and what you saw. A short numbered list is ideal.
40+
placeholder: |
41+
1. I started sign-in for `alice.example`.
42+
2. The browser opened and I approved access.
43+
3. My app received the callback URL.
44+
4. When I created the ATProtoKit session, I received the error below.
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: expected-result
50+
attributes:
51+
label: What did you expect to happen?
52+
description: Describe the result that would have let you continue.
53+
placeholder: "I expected the callback to create a session and an authenticated request to succeed."
54+
validations:
55+
required: true
56+
57+
- type: dropdown
58+
id: failure-stage
59+
attributes:
60+
label: Where did the OAuth flow stop?
61+
description: Choose the closest point, even if you are not certain.
62+
options:
63+
- Before the sign-in page opened
64+
- On the sign-in or consent page
65+
- When returning to the app or callback URL
66+
- While exchanging the authorization code
67+
- While creating or restoring the ATProtoKit session
68+
- During an authenticated request
69+
- While refreshing or resuming a session
70+
- While signing out or deleting a session
71+
- It did not stop, but behaved unexpectedly
72+
- I'm not certain
73+
validations:
74+
required: true
75+
76+
- type: input
77+
id: atprotokit-version
78+
attributes:
79+
label: ATProtoKit Version
80+
description: State the version or commit you are using.
81+
placeholder: "0.18.0 or commit abc1234"
82+
validations:
83+
required: true
84+
85+
- type: input
86+
id: oauth-implementation
87+
attributes:
88+
label: OAuth Package or Implementation
89+
description: Name the OAuth package and version you use. If you built it yourself or do not know, say so.
90+
placeholder: "PackageName 1.2.0, custom implementation, or I'm not sure"
91+
validations:
92+
required: true
93+
94+
- type: dropdown
95+
id: operating-system
96+
attributes:
97+
label: Where does this happen?
98+
multiple: true
99+
options:
100+
- macOS
101+
- iOS/iPadOS
102+
- tvOS
103+
- visionOS
104+
- watchOS
105+
- Linux
106+
- Windows
107+
- Other
108+
validations:
109+
required: true
110+
111+
- type: input
112+
id: environment-version
113+
attributes:
114+
label: Environment Version
115+
description: Include the operating system version and, when relevant, the Xcode or Swift version.
116+
placeholder: "iOS 19.0, Xcode 17.0"
117+
validations:
118+
required: true
119+
120+
- type: textarea
121+
id: minimal-code
122+
attributes:
123+
label: Relevant Code
124+
description: If possible, share the smallest code sample that shows how OAuth connects to ATProtoKit. Please remove credentials and private information.
125+
render: swift
126+
127+
- type: textarea
128+
id: diagnostics
129+
attributes:
130+
label: Error and Sanitized Diagnostics
131+
description: Paste the complete error and any useful sanitized logs, HTTP status codes, or endpoint hostnames. Attach screenshots or files below if that is easier.
132+
placeholder: |
133+
Error: ATOAuthSessionConfigurationError...
134+
HTTP status: 401
135+
Endpoint hostname: example.com
136+
137+
Replace credentials and private values with <redacted>.
138+
139+
- type: textarea
140+
id: additional-context
141+
attributes:
142+
label: Additional Context
143+
description: Share anything else that may help, such as whether this is consistent or intermittent, a link to a small reproduction, or a workaround you tried.
144+
145+
- type: checkboxes
146+
id: sensitive-information
147+
attributes:
148+
label: Sensitive Information
149+
options:
150+
- label: I have removed tokens, authorization codes, secrets, private keys, DPoP proofs, cookies, and complete authorization headers from this report.
151+
required: true

0 commit comments

Comments
 (0)