chore: improve issue templates #2645
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,57 @@ | ||
| --- | ||
| name: "\U0001F41E Bug report" | ||
| about: Report an issue with Vite | ||
| title: '' | ||
| labels: 'bug: pending triage' | ||
| assignees: '' | ||
| --- | ||
|
|
||
| <!-- 中文用户请注意：请仔细阅读以下模版，如果不遵循模版，issue 将会被直接关闭。 --> | ||
| <!-- IMPORTANT: Please do not ignore this template. If you do, your issue will be closed immediately. --> | ||
|
|
||
| ### Describe the bug | ||
|
|
||
| <!-- 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! --> | ||
|
|
||
| ### Reproduction | ||
|
|
||
| <!-- | ||
| Please provide a link to a repo that can reproduce the problem you ran into. | ||
|
|
||
| A reproduction is required unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. 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. | ||
| --> | ||
|
|
||
| ### System Info | ||
|
|
||
| - `vite` version: | ||
| - Operating System: | ||
| - Node version: | ||
| - Package manager (npm/yarn/pnpm) and version: | ||
|
There was a problem hiding this comment. Consider adding:
Which produces output like this: Are there any other packages we want to check the version of? There was a problem hiding this comment. This looks great, we could add that as a recommendation but I think nobody will do it if it is not required. I would really like this is required, but maybe it is too much. Let's add it with a strong word to try to push people that way at least |
||
|
|
||
| ### Logs <!-- (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. | ||
| `node` is used as highlight to improve some colors in stack-traces. | ||
| If it doesn't work quite well, try `console`. | ||
| --> | ||
|
|
||
| ```node | ||
|
|
||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ### Before submitting the issue, please make sure you do the following | ||
|
|
||
| - [ ] Read the [Contributing Guidelines](https://github.com/vitejs/vite/blob/main/.github/contributing.md). | ||
| - [ ] Read the [docs](https://vitejs.dev/guide). | ||
| - [ ] Check that there isn't already an issue that reports the same bug to avoid creating a duplicate. | ||
| - [ ] Provide a description in this issue that describes the bug. | ||
| - [ ] 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/vue-next instead. | ||
| - [ ] 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/). | ||
Shinigami92 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,25 @@ | ||
| --- | ||
| name: "\U0001F680 New feature proposal" | ||
| about: Propose a new feature to be added to Vite | ||
| title: '' | ||
| labels: 'feat: pending triage' | ||
| assignees: '' | ||
| --- | ||
|
|
||
| ### Clear and concise description of the problem | ||
|
|
||
| <!-- 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! --> | ||
|
|
||
| ### Suggested solution | ||
|
|
||
| <!-- In module [xy] we could provide following implementation... --> | ||
|
|
||
| ### Alternative | ||
|
|
||
| <!-- Clear and concise description of any alternative solutions or features you've considered. --> | ||
|
|
||
| ### Additional context | ||
|
|
||
| <!-- Any other context or screenshots about the feature request here. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The⚠️ emoji really draws attention to the warning, versus the newly commented out version. Maybe add that back in?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As the same with #2645 (comment), the text is only visible in the draft view of the issue and shown in the comment, therefore it is not rendered as an icon/emoji but an unicode symbol.
Is there maybe another way of drawing attention?
Maybe we could try
<!-- !!! IMPORTANT !!! Please do not ignore this template. If you do, your issue will be closed immediately. -->