From 0de0dba60f745f3e86d634c050be1fda7431efa1 Mon Sep 17 00:00:00 2001 From: Shinigami92 Date: Mon, 22 Mar 2021 18:51:29 +0100 Subject: [PATCH 01/16] chore: improve bug issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 38 ++++++++++++++++++++-------- 1 file changed, 27 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f9128faa16db05..f7419da947e19f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,25 +6,31 @@ labels: 'bug: pending triage' assignees: '' --- - + + -**⚠️ IMPORTANT ⚠️ Please do not ignore this template. If you do, your issue will be closed immediately.** +### Before submitting the issue, please make sure you do the following -- [ ] Read [the docs](https://vitejs.dev/guide/). +- [ ] 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/). +--- + ## Describe the bug -A clear and concise description of what the bug is. + ## Reproduction -Please provide a link to a repo that can reproduce the problem you ran into. + ## System Info @@ -33,7 +39,17 @@ A reproduction is **required** unless you are absolutely sure that the the probl - Node version: - Package manager (npm/yarn/pnpm) and version: -## Logs (Optional if provided reproduction) +## Logs + + + +```node -1. Run `vite` or `vite build` with the `--debug` flag. -2. Provide the error log here. +``` From b4d9c8c0260e9523b7bd683340b36b5872c40108 Mon Sep 17 00:00:00 2001 From: Shinigami92 Date: Mon, 22 Mar 2021 19:02:13 +0100 Subject: [PATCH 02/16] chore: use h3 --- .github/ISSUE_TEMPLATE/bug_report.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f7419da947e19f..7266e9ea4ae0f8 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -20,11 +20,11 @@ assignees: '' --- -## Describe the bug +### Describe the bug -## Reproduction +### Reproduction -## System Info +### System Info - `vite` version: - Operating System: - Node version: - Package manager (npm/yarn/pnpm) and version: -## Logs +### Logs + +### Suggested solution + + + +### Alternative -**Describe the solution you'd like** -A clear and concise description of what you want to happen. + -**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. + From bdd12bb64f0bdc7e6e1fa77b705e553a1df4c4e5 Mon Sep 17 00:00:00 2001 From: Shinigami92 Date: Mon, 22 Mar 2021 19:16:02 +0100 Subject: [PATCH 04/16] chore: improve name and about text --- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- .github/ISSUE_TEMPLATE/feature_request.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 7266e9ea4ae0f8..fd7aba1e6f702b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,6 @@ --- -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: '' diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 828df6c8a8480d..ecc8d06463604f 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,6 +1,6 @@ --- -name: Feature request -about: Suggest an idea for this project +name: "\U0001F680 New rule proposal" +about: Propose a new feature to be added to Vite title: '' labels: '' assignees: '' From bfe29834e635149d5063bb063f74f789e7a7ab48 Mon Sep 17 00:00:00 2001 From: Shinigami92 Date: Mon, 22 Mar 2021 19:16:44 +0100 Subject: [PATCH 05/16] chore: add checkbox to ask for pr by author --- .github/ISSUE_TEMPLATE/bug_report.md | 1 + .github/ISSUE_TEMPLATE/feature_request.md | 2 ++ 2 files changed, 3 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index fd7aba1e6f702b..173a00f28326f5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -17,6 +17,7 @@ assignees: '' - [ ] 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/). +- [ ] Are you willing to submit a pull request to fix this bug? --- diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index ecc8d06463604f..b24fbd887c14b3 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -21,3 +21,5 @@ assignees: '' ### Additional context + +- [ ] Are you willing to submit a pull request to implement this feature? From d5f8f28cc650429f125947a29d51dccd7a1e88a4 Mon Sep 17 00:00:00 2001 From: Shinigami92 Date: Mon, 22 Mar 2021 19:19:21 +0100 Subject: [PATCH 06/16] chore: i have not copied anything from eslint --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index b24fbd887c14b3..ea1706d80b423a 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,5 +1,5 @@ --- -name: "\U0001F680 New rule proposal" +name: "\U0001F680 New feature proposal" about: Propose a new feature to be added to Vite title: '' labels: '' From 23414f44ac1f318d086e7d201e48d5d74edef15c Mon Sep 17 00:00:00 2001 From: Shinigami92 Date: Mon, 22 Mar 2021 19:25:53 +0100 Subject: [PATCH 07/16] chore: improve hint text --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 173a00f28326f5..123c26ffccfb4f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -30,7 +30,7 @@ assignees: '' ### System Info From 1650c240e9b7a0bf01c4fedaa1e3f2fbaa2beff1 Mon Sep 17 00:00:00 2001 From: Shinigami92 Date: Mon, 22 Mar 2021 19:35:35 +0100 Subject: [PATCH 08/16] chore: revert bolding to improve readability --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 123c26ffccfb4f..4a16543ea1791c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -30,7 +30,7 @@ assignees: '' ### System Info From 106bb8891f6b86223b17b9724f55b2c0e1ef2961 Mon Sep 17 00:00:00 2001 From: Shinigami92 Date: Mon, 22 Mar 2021 19:37:25 +0100 Subject: [PATCH 09/16] chore: swap description with checkbox section This improves previews for embedded links in e.g Twitter or Discord --- .github/ISSUE_TEMPLATE/bug_report.md | 24 ++++++++++++------------ .github/PULL_REQUEST_TEMPLATE.md | 28 ++++++++++++++-------------- 2 files changed, 26 insertions(+), 26 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 4a16543ea1791c..6863ea4d89ec0a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -9,18 +9,6 @@ assignees: '' -### 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/). -- [ ] Are you willing to submit a pull request to fix this bug? - ---- - ### Describe the bug @@ -54,3 +42,15 @@ assignees: '' ```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/). +- [ ] Are you willing to submit a pull request to fix this bug? diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1f71cf3bc9d73a..ba1443320451f9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,12 +1,14 @@ -### 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. + + +### Additional context + + + +--- ### What is the purpose of this pull request? @@ -15,12 +17,10 @@ - [ ] Documentation update - [ ] Other ---- - -### Description - - - -### Additional context +### Before submitting the PR, please make sure you do the following - +- [ ] 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. From 07556b4ebc79b67827b43de93d0d86983223707c Mon Sep 17 00:00:00 2001 From: Shinigami92 Date: Mon, 22 Mar 2021 19:58:54 +0100 Subject: [PATCH 10/16] chore: auto-assign label feature pending triage --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index ea1706d80b423a..12476c12f7ae93 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,7 +2,7 @@ name: "\U0001F680 New feature proposal" about: Propose a new feature to be added to Vite title: '' -labels: '' +labels: 'feature: pending triage' assignees: '' --- From abc87a8c8d1042475aa611afd2aacce2c5547d46 Mon Sep 17 00:00:00 2001 From: Shinigami92 Date: Mon, 22 Mar 2021 20:05:23 +0100 Subject: [PATCH 11/16] chore: use positively connoted question --- .github/ISSUE_TEMPLATE/bug_report.md | 5 +++-- .github/ISSUE_TEMPLATE/feature_request.md | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 6863ea4d89ec0a..1898b4eace3ab4 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,5 +1,5 @@ --- -name: "\U0001F41E Bug report" +name: "\U0001F41E Bug report" about: Report an issue with Vite title: '' labels: 'bug: pending triage' @@ -13,6 +13,8 @@ assignees: '' + + ### Reproduction + + ### Suggested solution @@ -21,5 +23,3 @@ assignees: '' ### Additional context - -- [ ] Are you willing to submit a pull request to implement this feature? From 4ef596a43128fd76c6830670cf2f3e7b1b2d14b6 Mon Sep 17 00:00:00 2001 From: Shinigami92 Date: Mon, 22 Mar 2021 20:19:43 +0100 Subject: [PATCH 12/16] chore: use new label name --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 27b73d7c9af669..5d7a1f5413ca4c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,7 +2,7 @@ name: "\U0001F680 New feature proposal" about: Propose a new feature to be added to Vite title: '' -labels: 'feature: pending triage' +labels: 'feat: pending triage' assignees: '' --- From dd349d333ff342a013be5928b3a699fc2ae1326b Mon Sep 17 00:00:00 2001 From: Shinigami92 Date: Tue, 23 Mar 2021 09:06:21 +0100 Subject: [PATCH 13/16] chore: draw more attention --- .github/ISSUE_TEMPLATE/bug_report.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 1898b4eace3ab4..fda82f9f2b4032 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,7 +7,10 @@ assignees: '' --- - + ### Describe the bug From fb6d48542ea9e26067e1f77f35076951c9c9de4e Mon Sep 17 00:00:00 2001 From: Shinigami92 Date: Tue, 23 Mar 2021 09:12:48 +0100 Subject: [PATCH 14/16] chore: improve system info section --- .github/ISSUE_TEMPLATE/bug_report.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index fda82f9f2b4032..97259c8fbb380c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -28,10 +28,13 @@ assignees: '' ### System Info -- `vite` version: -- Operating System: -- Node version: -- Package manager (npm/yarn/pnpm) and version: +Output of `npx envinfo --system --npmPackages vite,@vitejs/plugin-vue --binaries --browsers`: + +```node + +``` + +Used package manager: ### Logs From 57c54a40e45f6f0169b25ff244bf5c52b0b39d34 Mon Sep 17 00:00:00 2001 From: Shinigami92 Date: Tue, 23 Mar 2021 09:14:37 +0100 Subject: [PATCH 15/16] chore: improve wording --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 97259c8fbb380c..913b88b5c74013 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -60,4 +60,4 @@ Used package manager: - [ ] 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/). +- [ ] Check 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/). From 41040016a9b1e29c9dfd6e3a7b536d0aa6313851 Mon Sep 17 00:00:00 2001 From: Shinigami92 Date: Tue, 23 Mar 2021 10:49:02 +0100 Subject: [PATCH 16/16] chore: improve wording --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 913b88b5c74013..0e7f412b35bb1d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -60,4 +60,4 @@ Used package manager: - [ ] 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 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/). +- [ ] 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/).