Clearer help instructions (#919)
This commit is contained in:
7
.github/ISSUE_TEMPLATE/bug_report.md
vendored
7
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -2,10 +2,15 @@
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ""
|
||||
labels: ""
|
||||
labels: "bug"
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
<!--
|
||||
⚠️ IMPORTANT: All sections marked as required must be completed in English.
|
||||
Issues that do not meet these requirements will be closed and may need to be resubmitted.
|
||||
-->
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
|
||||
2
.github/ISSUE_TEMPLATE/feature_request.md
vendored
2
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@@ -2,7 +2,7 @@
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ""
|
||||
labels: ""
|
||||
labels: "feature request"
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
|
||||
@@ -67,16 +67,21 @@ export function HelpDialog({ isOpen, onClose }: HelpDialogProps) {
|
||||
|
||||
// Create a formatted issue body with the debug info
|
||||
const issueBody = `
|
||||
## Bug Description
|
||||
<!--
|
||||
⚠️ IMPORTANT: All sections marked as required must be completed in English.
|
||||
Issues that do not meet these requirements will be closed and may need to be resubmitted.
|
||||
-->
|
||||
|
||||
## Bug Description (required)
|
||||
<!-- Please describe the issue you're experiencing -->
|
||||
|
||||
## Steps to Reproduce
|
||||
## Steps to Reproduce (required)
|
||||
<!-- Please list the steps to reproduce the issue -->
|
||||
|
||||
## Expected Behavior
|
||||
## Expected Behavior (required)
|
||||
<!-- What did you expect to happen? -->
|
||||
|
||||
## Actual Behavior
|
||||
## Actual Behavior (required)
|
||||
<!-- What actually happened? -->
|
||||
|
||||
## System Information
|
||||
@@ -97,7 +102,7 @@ ${debugInfo.logs.slice(-3_500) || "No logs available"}
|
||||
|
||||
// Create the GitHub issue URL with the pre-filled body
|
||||
const encodedBody = encodeURIComponent(issueBody);
|
||||
const encodedTitle = encodeURIComponent("[bug] <add title>");
|
||||
const encodedTitle = encodeURIComponent("[bug] <WRITE TITLE HERE>");
|
||||
const githubIssueUrl = `https://github.com/dyad-sh/dyad/issues/new?title=${encodedTitle}&labels=bug,filed-from-app&body=${encodedBody}`;
|
||||
|
||||
// Open the pre-filled GitHub issue page
|
||||
@@ -199,16 +204,20 @@ ${debugInfo.logs.slice(-3_500) || "No logs available"}
|
||||
const handleOpenGitHubIssue = () => {
|
||||
// Create a GitHub issue with the session ID
|
||||
const issueBody = `
|
||||
## Support Request
|
||||
<!--
|
||||
⚠️ IMPORTANT: All sections marked as required must be completed in English.
|
||||
Issues that do not meet these requirements will be closed and may need to be resubmitted.
|
||||
-->
|
||||
|
||||
Session ID: ${sessionId}
|
||||
|
||||
## Issue Description
|
||||
## Issue Description (required)
|
||||
<!-- Please describe the issue you're experiencing -->
|
||||
|
||||
## Expected Behavior
|
||||
## Expected Behavior (required)
|
||||
<!-- What did you expect to happen? -->
|
||||
|
||||
## Actual Behavior
|
||||
## Actual Behavior (required)
|
||||
<!-- What actually happened? -->
|
||||
`;
|
||||
|
||||
@@ -248,8 +257,8 @@ Session ID: ${sessionId}
|
||||
<span>{sessionId}</span>
|
||||
</div>
|
||||
<p className="text-center text-sm">
|
||||
Please open a GitHub issue so we can follow-up with you on this
|
||||
issue.
|
||||
You must open a GitHub issue for us to investigate. Without a
|
||||
linked issue, your report will not be reviewed.
|
||||
</p>
|
||||
</div>
|
||||
<DialogFooter>
|
||||
|
||||
Reference in New Issue
Block a user