chore: improve issue templates (#2645)

vitejs · Mar 23, 2021 · 524a018 · 524a018
1 parent 030db8c
commit 524a018
Show file tree

Hide file tree

Showing 3 changed files with 75 additions and 46 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,39 +1,63 @@
 ---
-name: Bug report
-about: Create a report to help us improve
+name: "\U0001F41E Bug report"
+about: Report an issue with Vite
 title: ''
 labels: 'bug: pending triage'
 assignees: ''
 ---
 
+<!-- 中文用户请注意：请仔细阅读以下模版，如果不遵循模版，issue 将会被直接关闭。 -->
 <!--
-中文用户请注意：请仔细阅读以下模版，如果不遵循模版，issue 将会被直接关闭。
+  !!! IMPORTANT !!!
+  Please do not ignore this template. If you do, your issue will be closed immediately.
 -->
 
-**⚠️ IMPORTANT ⚠️ Please do not ignore this template. If you do, your issue will be closed immediately.**
+### Describe the bug
 
-- [ ] Read [the docs](https://vitejs.dev/guide/).
-- [ ] 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/).
+<!-- 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.
 
-## Describe the bug
+  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.
+-->
 
-A clear and concise description of what the bug is.
+### System Info
 
-## Reproduction
+Output of `npx envinfo --system --npmPackages vite,@vitejs/plugin-vue --binaries --browsers`:
 
-Please provide a link to a repo that can reproduce the problem you ran into.
+```node
 
-A reproduction is **required** unless you are absolutely sure that the the problem is obvious and the information you provided is enough for us to understand what the problem is. If a report has only vague description (e.g. just a generic error message) and has no reproduction, it will receive "need reproduction" label. If no reproduction is provided after 3 days, it will be auto-closed.
+```
 
-## System Info
+Used package manager: <!-- npm | yarn | pnpm -->
 
-- `vite` version:
-- Operating System:
-- Node version:
-- Package manager (npm/yarn/pnpm) and version:
+### Logs <!-- (Optional if provided reproduction) -->
 
-## 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.
+  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.
+- [ ] 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/).
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,20 +1,25 @@
 ---
-name: Feature request
-about: Suggest an idea for this project
+name: "\U0001F680 New feature proposal"
+about: Propose a new feature to be added to Vite
 title: ''
-labels: ''
+labels: 'feat: pending triage'
 assignees: ''
-
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+### 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
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+<!-- Clear and concise description of any alternative solutions or features you've considered. -->
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+### Additional context
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+<!-- Any other context or screenshots about the feature request here. -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,12 +1,14 @@
 <!-- Thank you for contributing! -->
 
-### Before submitting the PR, please make sure you do the following
+### Description
 
-- [ ] Read the [Contributing Guidelines](https://github.com/vitejs/vite/blob/main/.github/contributing.md).
-- [ ] Read the [Pull Request Guidelines](https://github.com/vitejs/vite/blob/main/.github/contributing.md#pull-request-guidelines) and follow the [Commit Convention](https://github.com/vitejs/vite/blob/main/.github/commit-convention.md).
-- [ ] Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
-- [ ] Provide a description in this PR that addresses **what** the PR is solving, or reference the issue that it solves (e.g. `fixes #123`).
-- [ ] Ideally, include relevant tests that fail without this PR but pass with it.
+<!-- Please insert your description here and provide especially info about the "what" this PR is solving -->
+
+### Additional context
+
+<!-- e.g. is there anything you'd like reviewers to focus on? -->
+
+---
 
 ### What is the purpose of this pull request? <!-- (put an "X" next to an item) -->
 
@@ -15,12 +17,10 @@
 - [ ] Documentation update
 - [ ] Other
 
----
-
-### Description
-
-<!-- Please insert your description here and provide especially info about the "what" this PR is solving -->
-
-### Additional context
+### Before submitting the PR, please make sure you do the following
 
-<!-- e.g. is there anything you'd like reviewers to focus on? -->
+- [ ] Read the [Contributing Guidelines](https://github.com/vitejs/vite/blob/main/.github/contributing.md).
+- [ ] Read the [Pull Request Guidelines](https://github.com/vitejs/vite/blob/main/.github/contributing.md#pull-request-guidelines) and follow the [Commit Convention](https://github.com/vitejs/vite/blob/main/.github/commit-convention.md).
+- [ ] Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
+- [ ] Provide a description in this PR that addresses **what** the PR is solving, or reference the issue that it solves (e.g. `fixes #123`).
+- [ ] Ideally, include relevant tests that fail without this PR but pass with it.