Skip to content

Commit a9db245

Browse files
authored
Update bug_report.yml
Added placeholders as an example.
1 parent b2a9950 commit a9db245

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,34 @@ body:
1212
attributes:
1313
label: Summary
1414
description: Summarize the bug in one or two sentences.
15+
placeholder: "ATProtoKit fails to decode posts with custom facets, resulting in a decoding error."
1516
validations:
1617
required: true
1718
- type: textarea
1819
id: steps
1920
attributes:
2021
label: Reproduction Steps
2122
description: Describe how you were able to get the bug.
23+
placeholder: |
24+
1. Authenticate with a valid Bluesky account using ATProtoKit v1.2.0 on macOS Sonoma 14.4.
25+
2. Fetch a post containing a custom facet (e.g., a tag or link with a custom feature).
26+
3. Observe that decoding fails with a `DecodingError.dataCorrupted` error.
2227
validations:
2328
required: true
2429
- type: textarea
2530
id: expected-results
2631
attributes:
2732
label: Expected Results
2833
description: What were you expecting to happen?
34+
placeholder: "The post should be successfully decoded and all facets—including custom ones—should be present in the resulting data model."
2935
validations:
3036
required: true
3137
- type: textarea
3238
id: actual-results
3339
attributes:
3440
label: Actual Results
3541
description: What actually happened?
42+
placeholder: "A `DecodingError.dataCorrupted` error is thrown, and the post is not decoded. The error appears to be triggered by an unexpected or missing field in the facet JSON."
3643
validations:
3744
required: true
3845
- type: dropdown
@@ -56,17 +63,45 @@ body:
5663
attributes:
5764
label: Operating System Version
5865
description: For each operating system, give us the version numbers. For "Linux," state what distro you're using. For "Other," state what operating system you're using. For "Docker," state what version and Linux distro you're using.
66+
placeholder: |
67+
macOS Sonoma 14.4
68+
Linux (Ubuntu 22.04 LTS)
5969
validations:
6070
required: true
6171
- type: input
6272
id: atprotokit-version
6373
attributes:
6474
label: ATProtoKit Version
6575
description: State what version of ATProtoKit you're using.
76+
placeholder: "0.18.0"
6677
validations:
6778
required: true
6879
- type: textarea
6980
id: additional-context
7081
attributes:
7182
label: Additional Context
7283
description: Add any other context, screenshots, or videos about the bug here.
84+
placeholder: |
85+
This error only occurs for posts that contain custom facets. Standard posts without custom facets decode successfully.
86+
87+
Debug logs and a snippet of the failing JSON are attached below:
88+
```json
89+
{
90+
"facets": [
91+
{
92+
"type": "app.bsky.richtext.facet",
93+
"features": [
94+
{
95+
"type": "custom",
96+
"value": "example"
97+
}
98+
]
99+
}
100+
]
101+
}
102+
```
103+
104+
The error in question:
105+
```
106+
DecodingError.dataCorrupted(Swift.DecodingError.Context(codingPath: [...], debugDescription: "Invalid facet type", underlyingError: nil))
107+
```

0 commit comments

Comments
 (0)