Skip to content
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.

Sign up for GitHub

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 PR linting instructions #513

Merged
merged 4 commits into from
Dec 17, 2023
Merged

chore: Improve PR linting instructions #513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1fdcf36
chore: Update readme
lachlancollins Dec 17, 2023
c22e465
Add pull_request_template.md
lachlancollins Dec 17, 2023
6f40e45
Add reminder to lint before submitting
lachlancollins Dec 17, 2023
7c925bf
Merge branch 'main' into update-readme
lachlancollins Dec 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## 🎯 Changes

<!-- What changes are made in this PR? Is it a feature or a package submission? -->

## ✅ Checklist

- [ ] I have given my PR a descriptive title
- [ ] I have run `pnpm run lint` locally on my changes
15 changes: 4 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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`.
6 changes: 3 additions & 3 deletions src/routes/help/submitting/+page.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,9 +166,9 @@
</pre>
<br />
Copy this snippet and add it to
<a href="{repoURL}/blob/main/src/routes/{pathName}/{pathName}.json">{pathName}.json</a>. You can
propose your changes
<a href="{repoURL}/edit/main/src/routes/{pathName}/{pathName}.json">directly in GitHub</a>.
<a href="{repoURL}/blob/main/src/routes/{pathName}/{pathName}.json">{pathName}.json</a>. Before
submitting a PR, please clone your changes locally and run:
<pre>pnpm run lint</pre>

<style>
.json-generator,
Expand Down