From 1fdcf366342eb5ed9e28074027fb67f2780a9919 Mon Sep 17 00:00:00 2001 From: Lachlan Collins <1667261+lachlancollins@users.noreply.github.com> Date: Sun, 17 Dec 2023 15:51:25 +1100 Subject: [PATCH 1/3] chore: Update readme --- README.md | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 95572ccc6..980c0da91 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Svelte Society Website -Using SvelteKit! +Welcome to Svelte Society! This repository hosts the main website, which serves as a central index of events, a components directory, as well as recipes and other useful resources. ## Developing @@ -9,17 +9,10 @@ In order to start a development server: ```bash pnpm install pnpm run dev - -# or start the server and open the app in a new browser tab -pnpm run start ``` -## Building - -Before creating a production version of your app, install an [adapter](https://kit.svelte.dev/docs#adapters) for your target environment. Then: +## Contributing -```bash -pnpm run build -``` +If you would like to improve the site, you are very welcome to submit a PR! The website has a [form](https://sveltesociety.dev/help/submitting?type=component) which helps streamline adding your package or resource. -> You can preview the built app with `pnpm run preview`, regardless of whether you installed an adapter. This should _not_ be used to serve your app in production. +Please locally ensure your code passes `pnpm run lint` before submitting your PR. If you have Prettier formatting issues, please run `pnpm run format`. From c22e465055f9c66f1a9aaa138ce767bf76dc6ea1 Mon Sep 17 00:00:00 2001 From: Lachlan Collins <1667261+lachlancollins@users.noreply.github.com> Date: Sun, 17 Dec 2023 16:00:28 +1100 Subject: [PATCH 2/3] Add pull_request_template.md --- .github/pull_request_template.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..4af453826 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,8 @@ +## 🎯 Changes + + + +## ✅ Checklist + +- [ ] I have given my PR a descriptive title +- [ ] I have run `pnpm run lint` locally on my changes From 6f40e455b8a241a566bf6aebeec616ca1d54f0ce Mon Sep 17 00:00:00 2001 From: Lachlan Collins <1667261+lachlancollins@users.noreply.github.com> Date: Sun, 17 Dec 2023 16:00:49 +1100 Subject: [PATCH 3/3] Add reminder to lint before submitting --- src/routes/help/submitting/+page.svelte | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/routes/help/submitting/+page.svelte b/src/routes/help/submitting/+page.svelte index 3e2f63637..e51bfb82e 100644 --- a/src/routes/help/submitting/+page.svelte +++ b/src/routes/help/submitting/+page.svelte @@ -166,9 +166,9 @@
Copy this snippet and add it to -{pathName}.json. You can -propose your changes -directly in GitHub. +{pathName}.json. Before +submitting a PR, please clone your changes locally and run: +
pnpm run lint