-
-
Notifications
You must be signed in to change notification settings - Fork 6.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: improve issue templates #2645
Conversation
ideas:
|
This improves previews for embedded links in e.g Twitter or Discord
.github/ISSUE_TEMPLATE/bug_report.md
Outdated
|
||
**⚠️ IMPORTANT ⚠️ Please do not ignore this template. If you do, your issue will be closed immediately.** | ||
<!-- 中文用户请注意:请仔细阅读以下模版,如果不遵循模版,issue 将会被直接关闭。 --> | ||
<!-- IMPORTANT: Please do not ignore this template. If you do, your issue will be closed immediately. --> |
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
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. -->
.github/ISSUE_TEMPLATE/bug_report.md
Outdated
### System Info | ||
|
||
- `vite` version: | ||
- Operating System: | ||
- Node version: | ||
- Package manager (npm/yarn/pnpm) and version: |
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.
Consider adding:
- The output of
npx envinfo --system --npmPackages vite,@vitejs/plugin-vue --binaries --browsers
Which produces output like this:
System:
OS: Windows 10 10.0.19042
CPU: (16) x64 AMD Ryzen 7 3700X 8-Core Processor
Memory: 14.19 GB / 31.95 GB
Binaries:
Node: 14.16.0 - C:\Program Files\nodejs\node.EXE
Yarn: 1.22.10 - ~\AppData\Roaming\npm\yarn.CMD
npm: 7.6.1 - C:\Program Files\nodejs\npm.CMD
Browsers:
Chrome: 89.0.4389.90
Edge: Spartan (44.19041.423.0), Chromium (89.0.774.54)
Internet Explorer: 11.0.19041.1
npmPackages:
vite: ^2.1.2 => 2.1.2
Are there any other packages we want to check the version of?
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.
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
Before submitting the PR, please make sure you do the following
fixes #123
).What is the purpose of this pull request?
Description
This improves the issue templates to improve readability while triaging issues as a reviewer
Also users get provided with a bit more better hints and boilerplate texts are hidden by default in comments so they are not visible when the contributor posts the issue.
Additional context
Reviewer focus:
Reviewers can also have a look into the rendered markdown here:
https://github.com/Shinigami92/vite/blob/issue-templates/.github/ISSUE_TEMPLATE/bug_report.md
https://github.com/Shinigami92/vite/blob/issue-templates/.github/ISSUE_TEMPLATE/feature_request.md
https://discord.com/channels/804011606160703521/823110545266835456/823551400596209735