Skip to content

Commit 9842ffa

Browse files
authored
chore: improve issue templates (#8699)
1 parent a24f919 commit 9842ffa

File tree

2 files changed

+18
-8
lines changed

2 files changed

+18
-8
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

+15-6
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ body:
1111
attributes:
1212
label: Describe the bug
1313
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
14-
placeholder: Bug description
14+
placeholder: I am doing ... What I expect is ... What actually happening is ...
1515
validations:
1616
required: true
1717
- type: input
1818
id: reproduction
1919
attributes:
2020
label: Reproduction
21-
description: Please provide a link via [vite.new](https://vite.new/) or a link to a repo that can reproduce the problem you ran into. A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is required. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "need reproduction" label. If no reproduction is provided after 3 days, it will be auto-closed.
22-
placeholder: Reproduction
21+
description: Please provide a link via [vite.new](https://vite.new/) or a link to a repo that can reproduce the problem you ran into. A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is required ([Why?](https://antfu.me/posts/why-reproductions-are-required)). If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "need reproduction" label. If no reproduction is provided after 3 days, it will be auto-closed.
22+
placeholder: Reproduction URL and steps
2323
validations:
2424
required: true
2525
- type: textarea
@@ -50,8 +50,17 @@ body:
5050
Optional if provided reproduction. Please try not to insert an image but copy paste the log text.
5151
5252
1. Run `vite` or `vite build` with the `--debug` flag.
53-
2. Provide the error log here.
54-
render: shell
53+
2. Provide the error log here in the format below.
54+
55+
````
56+
<details>
57+
<summary>Click to expand!</summary>
58+
59+
```shell
60+
// paste the log text here
61+
```
62+
</details>
63+
````
5564
- type: checkboxes
5665
id: checkboxes
5766
attributes:
@@ -66,7 +75,7 @@ body:
6675
required: true
6776
- label: Check that there isn't [already an issue](https://github.com/vitejs/vite/issues) that reports the same bug to avoid creating a duplicate.
6877
required: true
69-
- label: Make sure this is a Vite issue and not a framework-specific issue. For example, if it's a Vue SFC related bug, it should likely be reported to https://github.com/vuejs/core instead.
78+
- label: Make sure this is a Vite issue and not a framework-specific issue. For example, if it's a Vue SFC related bug, it should likely be reported to [vuejs/core](https://github.com/vuejs/core) instead.
7079
required: true
7180
- label: Check that this is a concrete bug. For Q&A open a [GitHub Discussion](https://github.com/vitejs/vite/discussions) or join our [Discord Chat Server](https://chat.vitejs.dev/).
7281
required: true

.github/ISSUE_TEMPLATE/feature_request.yml

+3-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ body:
99
- type: textarea
1010
id: feature-description
1111
attributes:
12-
label: Clear and concise description of the problem
13-
description: "As a developer using Vite I want [goal / wish] so that [benefit]. If you intend to submit a PR for this issue, tell us in the description. Thanks!"
12+
label: Description
13+
description: "Clear and concise description of the problem. Please make the reason and usecases as detailed as possible. If you intend to submit a PR for this issue, tell us in the description. Thanks!"
14+
placeholder: As a developer using Vite I want [goal / wish] so that [benefit].
1415
validations:
1516
required: true
1617
- type: textarea

0 commit comments

Comments
 (0)