Skip to content

Commit 1197329

Browse files
committed
fix(Core): use new bug reporting format for GitHub issues
1 parent 36d8656 commit 1197329

1 file changed

Lines changed: 53 additions & 2 deletions

File tree

SnapX.Core/Utils/Helpers.cs

Lines changed: 53 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,60 @@ public static char GetRandomChar(string chars)
109109
{
110110
try
111111
{
112-
// Format the title and body for the issue
113112
var title = StripPII(ex.Message);
114-
var body = StripPII($"### Exception Details:\n\n{ex.Message}\n\n### Stack Trace:\n\n```\n{ex.StackTrace}\n```\n\nInner Exception: {ex.InnerException?.Message}\n\n## Stack Trace:\n\n```\n{ex.InnerException?.StackTrace}\n```\n\nAssembly: {Assembly.GetEntryAssembly()}\n\nOperating System: {OsInfo.GetFancyOSNameAndVersion()}");
113+
var innerExceptionBlock = ex.InnerException is not null ? StripPII($@"### Inner Exception: {ex.InnerException?.Message}
114+
115+
### Stack Trace:
116+
117+
```csharp
118+
{ex.InnerException?.StackTrace}
119+
```") : string.Empty;
120+
var body = StripPII(
121+
$@"### Is there an existing issue for this?
122+
123+
- [ ] I have searched the [existing issues]({Links.GitHubIssues})
124+
125+
### What happened?
126+
127+
<!-- Please describe what you were doing when the error occurred -->
128+
129+
### What did you expect?
130+
131+
<!-- Please describe what you expected to happen instead -->
132+
133+
### Relevant log output
134+
135+
<!--
136+
LOG OUTPUT IS NOT INCLUDED BY DEFAULT FOR PRIVACY REASONS
137+
138+
Since SnapX is in development, logs may contain sensitive information
139+
such as API keys, file paths, or other personally identifiable information (PII).
140+
141+
It is your responsibility to review and strip any PII before sharing log content.
142+
143+
If you need to include log output to help diagnose the issue, please:
144+
1. Check the logs in your SnapX configuration folder
145+
2. Carefully review and remove any sensitive information
146+
3. Paste the relevant portions below
147+
-->
148+
149+
```shell
150+
151+
```
152+
153+
### Exception Details: {ex.Message}
154+
155+
### Stack Trace:
156+
157+
```csharp
158+
{ex.StackTrace}
159+
```
160+
161+
{innerExceptionBlock}
162+
163+
Assembly: {Assembly.GetEntryAssembly()}
164+
.NET Version: {SnapXResources.Dotnet}
165+
Operating System: {OsInfo.GetFancyOSNameAndVersion()}");
115166

116167
var encodedTitle = HttpUtility.UrlEncode(title);
117168
var encodedBody = HttpUtility.UrlEncode(body);

0 commit comments

Comments
 (0)