Skip to content

Commit 3598a5f

Browse files
authored
docs: update guidelines
1 parent fbdf188 commit 3598a5f

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@ A collection of Svelte(Kit) examples showcasing various use cases, apps and inte
77
Before creating a new example, please first open an issue to discuss it. Here are a few rules to keep in mind:
88

99
- examples should be focused on a specific use case (TODO app) or technology (how to integrate TailwindCSS), but not both if possible
10-
- examples should be self-contained and minimal so that people can grasp them quickly
10+
- examples should be self-contained and minimal so that people can grasp them quickly. At the same time, it should not be too closely related to other examples. It may be better to enhance an existing example sometimes to group things
1111
- examples should be stable so that maintenance effort is low
1212

13-
Once a new example is agreed upon, a PR is welcome to implement it. The example should contain a `README.md` that describes what the example is about and some of the technical decisions that were made/packages that were used.
13+
Once a new example is agreed upon, a PR is welcome to implement it. Guidelines for creating an example:
14+
15+
- the example should contain a `README.md` that describes what the example is about and some of the technical decisions that were made/packages that were used
16+
- it should look visually pleasing while not requiring too much code to make it that way. E.g. a bunch of styles tucked a way in a `style` is ok, a Svelte transition/animation here and there is ok, but a bunch of HTML/JS code only related to visuals should be avoided

0 commit comments

Comments
 (0)