Unverified 提交 ac948412 authored 作者: Will Chen's avatar Will Chen 提交者: GitHub

Clearer help instructions (#919)

上级 c6eb3975
...@@ -2,10 +2,15 @@ ...@@ -2,10 +2,15 @@
name: Bug report name: Bug report
about: Create a report to help us improve about: Create a report to help us improve
title: "" title: ""
labels: "" labels: "bug"
assignees: "" 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** **Describe the bug**
A clear and concise description of what the bug is. A clear and concise description of what the bug is.
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
name: Feature request name: Feature request
about: Suggest an idea for this project about: Suggest an idea for this project
title: "" title: ""
labels: "" labels: "feature request"
assignees: "" assignees: ""
--- ---
......
...@@ -67,16 +67,21 @@ export function HelpDialog({ isOpen, onClose }: HelpDialogProps) { ...@@ -67,16 +67,21 @@ export function HelpDialog({ isOpen, onClose }: HelpDialogProps) {
// Create a formatted issue body with the debug info // Create a formatted issue body with the debug info
const issueBody = ` 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 --> <!-- Please describe the issue you're experiencing -->
## Steps to Reproduce ## Steps to Reproduce (required)
<!-- Please list the steps to reproduce the issue --> <!-- Please list the steps to reproduce the issue -->
## Expected Behavior ## Expected Behavior (required)
<!-- What did you expect to happen? --> <!-- What did you expect to happen? -->
## Actual Behavior ## Actual Behavior (required)
<!-- What actually happened? --> <!-- What actually happened? -->
## System Information ## System Information
...@@ -97,7 +102,7 @@ ${debugInfo.logs.slice(-3_500) || "No logs available"} ...@@ -97,7 +102,7 @@ ${debugInfo.logs.slice(-3_500) || "No logs available"}
// Create the GitHub issue URL with the pre-filled body // Create the GitHub issue URL with the pre-filled body
const encodedBody = encodeURIComponent(issueBody); 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}`; 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 // Open the pre-filled GitHub issue page
...@@ -199,16 +204,20 @@ ${debugInfo.logs.slice(-3_500) || "No logs available"} ...@@ -199,16 +204,20 @@ ${debugInfo.logs.slice(-3_500) || "No logs available"}
const handleOpenGitHubIssue = () => { const handleOpenGitHubIssue = () => {
// Create a GitHub issue with the session ID // Create a GitHub issue with the session ID
const issueBody = ` 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} Session ID: ${sessionId}
## Issue Description ## Issue Description (required)
<!-- Please describe the issue you're experiencing --> <!-- Please describe the issue you're experiencing -->
## Expected Behavior ## Expected Behavior (required)
<!-- What did you expect to happen? --> <!-- What did you expect to happen? -->
## Actual Behavior ## Actual Behavior (required)
<!-- What actually happened? --> <!-- What actually happened? -->
`; `;
...@@ -248,8 +257,8 @@ Session ID: ${sessionId} ...@@ -248,8 +257,8 @@ Session ID: ${sessionId}
<span>{sessionId}</span> <span>{sessionId}</span>
</div> </div>
<p className="text-center text-sm"> <p className="text-center text-sm">
Please open a GitHub issue so we can follow-up with you on this You must open a GitHub issue for us to investigate. Without a
issue. linked issue, your report will not be reviewed.
</p> </p>
</div> </div>
<DialogFooter> <DialogFooter>
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论