From 9e000ef1ed4678ce101df355b5674802dc22c4d1 Mon Sep 17 00:00:00 2001 From: Ben McCann <322311+benmccann@users.noreply.github.com> Date: Thu, 2 Mar 2023 14:34:14 -0800 Subject: [PATCH 1/2] chore: restore bug reporting section of readme --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- README.md | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 9cde9158408c..a94d39153bd8 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -9,7 +9,7 @@ body: id: bug-description attributes: label: Describe the bug - description: Please check if bugs related to building are caused by Vite and [file there](https://github.com/vitejs/vite/issues) if appropriate. If you intend to submit a PR for this issue, tell us in the description. Thanks! + description: Please [check if bugs related to building are caused by Vite](https://github.com/sveltejs/kit#bug-reporting) and [file there](https://github.com/vitejs/vite/issues) if appropriate. If you intend to submit a PR for this issue, tell us in the description. Thanks! placeholder: Bug description validations: required: true diff --git a/README.md b/README.md index fb5282e9f4e7..676cc88c2f4e 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,12 @@ Web development, streamlined. Read the [documentation](https://kit.svelte.dev/do [Additional adapters](<(https://sveltesociety.dev/components#adapters)>) are maintained by the community. +## Bug reporting + +Please make sure the issue you're reporting involves SvelteKit. Many issues related to how a project builds originate from [Vite](https://vitejs.dev/), which is used to build a SvelteKit project. It's important to note that new Vite projects don't use SSR by default, and so if you create a new Vite project from scratch, many issues won't reproduce. You should thus start with a project that utilizes SSR, such as `npm create vite-extra@latest -- --template ssr-svelte`. + +If an issue originates from Vite, please report it in the [Vite issue tracker](https://github.com/vitejs/vite/issues). + ## Contributing See [CONTRIBUTING.md](./CONTRIBUTING.md) for information on how to develop SvelteKit locally. From 896774d847e3bf86f2269cad84f68abed4da962e Mon Sep 17 00:00:00 2001 From: Rich Harris Date: Fri, 3 Mar 2023 11:26:13 -0500 Subject: [PATCH 2/2] Update README.md Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 676cc88c2f4e..65ff09b6b9b1 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Web development, streamlined. Read the [documentation](https://kit.svelte.dev/do ## Bug reporting -Please make sure the issue you're reporting involves SvelteKit. Many issues related to how a project builds originate from [Vite](https://vitejs.dev/), which is used to build a SvelteKit project. It's important to note that new Vite projects don't use SSR by default, and so if you create a new Vite project from scratch, many issues won't reproduce. You should thus start with a project that utilizes SSR, such as `npm create vite-extra@latest -- --template ssr-svelte`. +Please make sure the issue you're reporting involves SvelteKit. Many issues related to how a project builds originate from [Vite](https://vitejs.dev/), which is used to build a SvelteKit project. You can create a new Vite project with `npm create vite@latest` for client-side only repros and `npm create vite-extra@latest` for SSR or library repros. If an issue originates from Vite, please report it in the [Vite issue tracker](https://github.com/vitejs/vite/issues).