Skip to content

Commit 79b4ab2

Browse files
authored
feat: issue template changes to nudge users to making better issues (#2737)
1 parent 0e57e2a commit 79b4ab2

File tree

1 file changed

+37
-30
lines changed

1 file changed

+37
-30
lines changed

.github/ISSUE_TEMPLATE/1.bug_report.yml

Lines changed: 37 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@ name: Bug Report
22
description: Create a bug report for React Email
33
labels: ["Type: Bug"]
44
body:
5+
- type: input
6+
attributes:
7+
label: What versions are you using? (if relevant)
8+
value: "@react-email/components@x.y.z, react-email@x.y.z, etc."
59
- type: textarea
610
attributes:
711
label: Describe the Bug
@@ -10,45 +14,47 @@ body:
1014
required: true
1115
- type: dropdown
1216
attributes:
13-
label: Which package is affected (leave empty if unsure)
17+
label: What is affected (leave empty if unsure)
1418
multiple: true
1519
options:
16-
- "@react-email/body"
17-
- "@react-email/button"
18-
- "@react-email/column"
19-
- "@react-email/components"
20-
- "@react-email/container"
21-
- "@react-email/font"
22-
- "@react-email/head"
23-
- "@react-email/heading"
24-
- "@react-email/hr"
25-
- "@react-email/html"
26-
- "@react-email/img"
27-
- "@react-email/link"
28-
- "@react-email/preview"
29-
- "@react-email/render"
30-
- "@react-email/row"
31-
- "@react-email/section"
32-
- "@react-email/tailwind"
33-
- "@react-email/text"
34-
- "client"
35-
- "create-email"
36-
- "demo"
37-
- "docs"
38-
- "examples"
39-
- "react-email"
40-
- "web"
41-
- type: input
20+
- "Preview Server"
21+
- "CLI"
22+
- "Html Component"
23+
- "Body Component"
24+
- "Head Component"
25+
- "Button Component"
26+
- "Container Component"
27+
- "CodeBlock Component"
28+
- "CodeInline Component"
29+
- "Column Component"
30+
- "Row Component"
31+
- "Font Component"
32+
- "Heading Component"
33+
- "Hr Component"
34+
- "Img Component"
35+
- "Link Component"
36+
- "Markdown Component"
37+
- "Preview Component"
38+
- "Section Component"
39+
- "Tailwind Component"
40+
- "Text Component"
41+
- "Render Utility"
42+
- "@react-email/components package"
43+
- "npx create-email"
44+
- "Demo"
45+
- "Website"
46+
- "Examples"
47+
- type: textarea
4248
attributes:
4349
label: Link to the code that reproduces this issue
44-
description: |
45-
A link to a GitHub repository minimal reproduction. A minimal reproduction code is really helpful to understand the issue.
50+
value: |
51+
A link to a GitHub repository minimal reproduction. Not your entire project, just the code necessary to reproduce the issue. Try going from the starter `npx create-email@latest` and adding only what's needed to cause the issue. If you don't share a reproduction, we might close the issue or it will take significantly longer for things to get sorted out.
4652
validations:
4753
required: true
4854
- type: textarea
4955
attributes:
5056
label: To Reproduce
51-
description: Steps to reproduce the behavior, please provide a clear description of how to reproduce the issue, based on the linked minimal reproduction. Screenshots can be provided in the issue body below. If using code blocks, make sure that [syntax highlighting is correct](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) and double check that the rendered preview is not broken.
57+
value: Steps to reproduce the behavior, please provide a clear description of how to reproduce the issue, based on the linked minimal reproduction. Screenshots can be provided in the issue body below. If using code blocks, make sure that [syntax highlighting is correct](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) and double check that the rendered preview is not broken.
5258
validations:
5359
required: true
5460
- type: textarea
@@ -67,3 +73,4 @@ body:
6773
attributes:
6874
label: What's your node version? (if relevant)
6975
description: "Please specify the exact version."
76+

0 commit comments

Comments
 (0)