Skip to content

Commit adb24c3

Browse files
sarahetterascorbic
andauthored
chore: switch to more detailed yml based bug report template (#352)
* chore: switch to more detailed yml based bug report template * chore: text change Co-authored-by: Matt Kane <m@mk.gg> * chore: add field to collect gatsby info output Co-authored-by: Matt Kane <m@mk.gg>
1 parent c0c9bfc commit adb24c3

File tree

2 files changed

+186
-57
lines changed

2 files changed

+186
-57
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 57 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
1+
name: Bug Report
2+
description: Create a report to help us improve
3+
title: '[Bug]: '
4+
labels: ['type: bug']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report! Using this template makes it a lot easier for us to diagnose your problem, so please fill in as many fields as possible.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Summary
15+
description: A short description of the problem
16+
placeholder: |
17+
Include what you expected to happen, and what actually happened.
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: steps-to-reproduce
22+
attributes:
23+
label: Steps to reproduce
24+
description: Steps to reproduce the behavior
25+
placeholder: |
26+
1. Go to '...'
27+
2. Click on '....'
28+
3. Scroll down to '....'
29+
4. See error
30+
validations:
31+
required: true
32+
- type: input
33+
id: link-to-reproduction
34+
attributes:
35+
label: A link to a reproduction repository
36+
description:
37+
The fastest way to describe your bug is to provide a reproduction
38+
repository.
39+
placeholder: https://github.com/project/link-to-your-reproduction-repo
40+
41+
- type: input
42+
id: plugin-version
43+
attributes:
44+
label: Plugin version
45+
description:
46+
The version of `@netlify/plugin-gatsby` that you are using. (This is in
47+
the build logs)
48+
placeholder: x.x.x
49+
validations:
50+
required: true
51+
52+
- type: checkboxes
53+
id: more-info
54+
attributes:
55+
label: More information about your build
56+
options:
57+
- label: I am building using the CLI
58+
- label: I am building using file-based configuration (`netlify.toml`)
59+
- type: dropdown
60+
id: which-os
61+
attributes:
62+
label: What OS are you using?
63+
description: (If you're using the CLI) What OS are you using?
64+
options:
65+
- Windows
66+
- Mac OS
67+
- Linux
68+
- Other
69+
- type: textarea
70+
id: netlify-toml
71+
attributes:
72+
label: Your netlify.toml file
73+
description:
74+
(If you're using file-based config) Please provide a copy of your
75+
`netlify.toml` file.
76+
value: |
77+
<details>
78+
<summary>`netlify.toml`</summary>
79+
80+
```toml
81+
# Paste content of your `netlify.toml` file here
82+
```
83+
84+
</details>
85+
86+
- type: textarea
87+
id: gatsby-config
88+
attributes:
89+
label: Configuration
90+
description:
91+
Please provide command line options and/or configuration file, if any.
92+
value: |
93+
<details>
94+
<summary>`gatsby-config.js` and options</summary>
95+
96+
```
97+
# Paste content of your `gatsby-config.js` file, and/or command line options here. Check there is no private info in there.
98+
```
99+
100+
</details>
101+
- type: textarea
102+
id: environment
103+
attributes:
104+
label: Environment
105+
description: |
106+
Enter the following command in a terminal and copy/paste its output:
107+
108+
```bash
109+
npx envinfo --system --binaries --browsers --npmPackages @netlify/plugin-gatsby
110+
```
111+
value: |
112+
<details>
113+
<summary>Environment</summary>
114+
115+
```
116+
# Paste output from `npx envinfo` here.
117+
```
118+
119+
</details>
120+
121+
- type: textarea
122+
id: gatsby-info
123+
attributes:
124+
label: Gatsby info
125+
description: |
126+
Enter the following command in a terminal and copy/paste its output:
127+
128+
```bash
129+
gatsby info
130+
```
131+
value: |
132+
<details>
133+
<summary>gatsby info</summary>
134+
135+
```
136+
# Paste output from `gatsby info` here.
137+
```
138+
139+
</details>
140+
141+
- type: textarea
142+
id: redirects-file
143+
attributes:
144+
label: Your _redirects file
145+
description:
146+
Please provide a copy of your `_redirects` file if you have one.
147+
value: |
148+
<details>
149+
<summary>`_redirects`</summary>
150+
151+
```toml
152+
# Paste content of your `_redirects` file here
153+
```
154+
155+
</details>
156+
157+
- type: textarea
158+
id: build-logs
159+
attributes:
160+
label: Builds logs (or link to your logs)
161+
value: |
162+
<details>
163+
<summary>Build logs</summary>
164+
165+
```
166+
# Paste logs here
167+
```
168+
169+
</details>
170+
171+
- type: textarea
172+
id: function-logs
173+
attributes:
174+
label: Function logs
175+
description:
176+
If it is a runtime error with DSG, SSR or API pages, please provide a
177+
copy of the relevant function log logs.
178+
value: |
179+
<details>
180+
<summary>Function logs</summary>
181+
182+
```
183+
# Paste logs here
184+
```
185+
186+
</details>

0 commit comments

Comments
 (0)