Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve DevTools bug template text #21413

Merged
merged 1 commit into from
May 3, 2021
Merged

Improve DevTools bug template text #21413

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 37 additions & 19 deletions packages/react-devtools-shared/src/devtools/views/ErrorBoundary/ReportNewIssue.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ import * as React from 'react';
import Icon from '../Icon';
import styles from './shared.css';

function encodeURIWrapper(string: string): string {
return encodeURI(string).replace(/#/g, '%23');
}

type Props = {|
callStack: string | null,
componentStack: string | null,
Expand All @@ -28,26 +32,40 @@ export default function ReportNewIssue({
}

const title = `Error: "${errorMessage || ''}"`;
const label = 'Component: Developer Tools';

let body = 'Describe what you were doing when the bug occurred:';
body += '\n1. ';
body += '\n2. ';
body += '\n3. ';
body += '\n\n---------------------------------------------';
body += '\nPlease do not remove the text below this line';
body += '\n---------------------------------------------';
body += `\n\nDevTools version: ${process.env.DEVTOOLS_VERSION || ''}`;
if (callStack) {
body += `\n\nCall stack: ${callStack.trim()}`;
}
if (componentStack) {
body += `\n\nComponent stack: ${componentStack.trim()}`;
}
const labels = ['Component: Developer Tools', 'Status: Unconfirmed'];

const body = `
<!-- Please answer both questions below before submitting this issue. -->

### Which website or app were you using when the bug happened?

Please provide a link to the URL of the website (if it is public), a CodeSandbox (https://codesandbox.io/s/new) example that reproduces the bug, or a project on GitHub that we can checkout and run locally.

### What were you doing on the website or app when the bug happened?

If possible, please describe how to reproduce this bug on the website or app mentioned above:
1. <!-- FILL THIS IN -->
2. <!-- FILL THIS IN -->
3. <!-- FILL THIS IN -->

<!--------------------------------------------------->
<!-- Please do not remove the text below this line -->
<!--------------------------------------------------->

### Generated information

DevTools version: ${process.env.DEVTOOLS_VERSION || ''}

Call stack:
${callStack || '(not available)'}

Component stack:
${componentStack || '(not available)'}
`;

bugURL += `/issues/new?labels=${encodeURI(label)}&title=${encodeURI(
title,
)}&body=${encodeURI(body)}`;
bugURL += `/issues/new?labels=${encodeURIWrapper(
labels.join(','),
)}&title=${encodeURIWrapper(title)}&body=${encodeURIWrapper(body.trim())}`;

return (
<div className={styles.GitHubLinkRow}>
Expand Down