Skip to content

Commit

Permalink
chore: improve issue templates (#8699)
Browse files Browse the repository at this point in the history
  • Loading branch information
sapphi-red committed Jun 21, 2022
1 parent 3f9e5d4 commit 0cbb33b
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 8 deletions.
21 changes: 15 additions & 6 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Expand Up @@ -11,15 +11,15 @@ body:
attributes:
label: Describe the bug
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!
placeholder: Bug description
placeholder: I am doing ... What I expect is ... What actually happening is ...
validations:
required: true
- type: input
id: reproduction
attributes:
label: Reproduction
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.
placeholder: Reproduction
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.
placeholder: Reproduction URL and steps
validations:
required: true
- type: textarea
Expand Down Expand Up @@ -50,8 +50,17 @@ body:
Optional if provided reproduction. Please try not to insert an image but copy paste the log text.
1. Run `vite` or `vite build` with the `--debug` flag.
2. Provide the error log here.
render: shell
2. Provide the error log here in the format below.
````
<details>
<summary>Click to expand!</summary>
```shell
// paste the log text here
```
</details>
````
- type: checkboxes
id: checkboxes
attributes:
Expand All @@ -66,7 +75,7 @@ body:
required: true
- 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.
required: true
- 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.
- 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.
required: true
- 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/).
required: true
Expand Down
5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Expand Up @@ -9,8 +9,9 @@ body:
- type: textarea
id: feature-description
attributes:
label: Clear and concise description of the problem
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!"
label: Description
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!"
placeholder: As a developer using Vite I want [goal / wish] so that [benefit].
validations:
required: true
- type: textarea
Expand Down

0 comments on commit 0cbb33b

Please sign in to comment.