You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+22-31Lines changed: 22 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,52 +9,49 @@
9
9
10
10
## Release
11
11
12
-
The module is released automatically from the `main` and `next` branches using [semantic-release-action][]. Version bumps and change logs are generated from the commit messages.
12
+
The module is released automatically from the `main` and `next` branches using [multi-semantic-release][]. Version bumps and change logs are generated from the commit messages.
If you would like to preview the release from a given branch, and...
16
+
## Development setup
19
17
20
-
- You have push access to the repository
21
-
- The branch exists in GitHub
18
+
This repository uses `pnpm` as its package manager. See the `pnpm`[installation guide](https://pnpm.io/installation) to set it up through whatever method you prefer.
22
19
23
-
...you can preview the next release version and changelog using:
20
+
After cloning the repository, use the `setup` script to install dependencies, build, and run all checks:
24
21
25
22
```shell
26
-
npm run preview-release
23
+
pnpm run setup
27
24
```
28
25
29
-
##Development setup
26
+
### Build
30
27
31
-
After cloning the repository, use the `setup` script to install dependencies and run all checks:
28
+
To build types and docs:
32
29
33
30
```shell
34
-
npm run setup
31
+
pnpm run build
35
32
```
36
33
37
34
### Lint and format
38
35
39
36
Run auto-formatting to ensure any changes adhere to the code style of the repository:
40
37
41
38
```shell
42
-
npm run format
39
+
pnpm run format
43
40
```
44
41
45
42
To run lint and format checks without making any changes:
46
43
47
44
```shell
48
-
npm run lint
45
+
pnpm run lint
49
46
```
50
47
51
48
### Test
52
49
53
50
Run unit tests once or in watch mode:
54
51
55
52
```shell
56
-
npmtest
57
-
npm run test:watch
53
+
pnpmtest
54
+
pnpm run test:watch
58
55
```
59
56
60
57
### Using different versions of Svelte
@@ -63,34 +60,28 @@ Use the provided script to set up your environment for different versions of Sve
63
60
64
61
```shell
65
62
# Svelte 5
66
-
npm run install:5
67
-
npm run all
63
+
pnpm run install:5
64
+
pnpm run all
68
65
69
66
# Svelte 4
70
-
npm run install:4
71
-
npm run all:legacy
67
+
pnpm run install:4
68
+
pnpm run all:legacy
72
69
73
70
# Svelte 3
74
-
npm run install:3
75
-
npm run all:legacy
71
+
pnpm run install:3
72
+
pnpm run all:legacy
76
73
```
77
74
78
-
### Docs
79
-
80
-
Use the `docs` script to ensure the README's table of contents is up to date:
81
-
82
-
```shell
83
-
npm run docs
84
-
```
75
+
### Contributors
85
76
86
77
Use `contributors:add` to add a contributor to the README:
87
78
88
79
```shell
89
-
npm run contributors:add
80
+
pnpm run contributors:add
90
81
```
91
82
92
83
Use `contributors:generate` to ensure the README's contributor list is up to date:
0 commit comments