Skip to content

Commit ec26507

Browse files
committed
chore: make people aware of synced content
1 parent 1252f24 commit ec26507

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
### A note on documentation PRs
2+
3+
If this is a documentation PR (i.e. changing content within `apps/svelte.dev/content/docs`), then this is the wrong repository to make those changes. The content in this folder is synced from other repositories. Therefore, these changes should be made in their respective repositories (at https://github.com/sveltejs/svelte or https://github.com/sveltejs/kit, or example).
4+
5+
### Before submitting the PR, please make sure you do the following
6+
7+
- [ ] It's really useful if your PR references an issue where it is discussed ahead of time.
8+
- [ ] Prefix your PR title with `feat:`, `fix:`, `chore:`, or `docs:`.
9+
- [ ] This message body should clearly illustrate what problems it solves.

apps/svelte.dev/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
This is the app behind [svelte.dev](https://svelte.dev), the official Svelte site.
44

5+
## Documentation PRs
6+
7+
If you're creating a documentation PR, make sure you're targeting the right repository. More specifically, changes to content within `apps/svelte.dev/content/docs` are synced from other repositories, and documentation changes within those folder should therefore be made in those repositories:
8+
9+
- `docs/svelte` -> https://github.com/sveltejs/svelte
10+
- `docs/kit` -> https://github.com/sveltejs/kit
11+
- `docs/cli` -> https://github.com/sveltejs/cli
12+
13+
The tutorial, blog and examples are maintained within this repository.
14+
515
## Development
616

717
### Tutorial

0 commit comments

Comments
 (0)