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
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,29 +5,29 @@ We welcome contributions including bug fixes, feature enhancements, documentatio
5
5
6
6
## Creating a Template
7
7
8
-
We do not maintain official templates and integration in this monorepo.
8
+
We do not maintain official templates and integrations in this monorepo.
9
9
Instead, please head over to [solidjs/templates](https://github.com/solidjs/templates) to submit your contribution.
10
10
11
11
## Documentation
12
12
13
13
We always want help and creative ways of explaining how to take the best out of SolidStart.
14
-
Alas, this is not the right place to do it, please head over to [SolidDocs](https://github.com/solidjs/solid-docs) and offer contribution to the official documentation!
14
+
Alas, this is not the right place to do it, please head over to [SolidDocs](https://github.com/solidjs/solid-docs) and contribute to the official documentation!
15
15
16
16
## Feature Request
17
17
18
18
> [!IMPORTANT]
19
-
> Do not create a PR without first discussion in an issue
19
+
> Do not create a PR without prior discussion in an issue
20
20
21
21
If there's a new feature you'd like to request you can:
22
22
23
23
1. Create an issue and make your pitch. Be sure to explain the value proposition in a way that will benefit most users.
24
24
25
25
2. If it's a more general concept, feel free to open a [Discussion](https://github.com/solidjs/solid-start/discussions) in the **Idea** category.
26
26
27
-
A new **primitive** follows the same criteria as issues, please create an issue for it to be discussed before hand.
27
+
A new **primitive** follows the same criteria as issues, please create an issue for it to be discussed beforehand.
28
28
29
29
Primitives that depend on multiple external dependencies and 3rd party integrations are generally not a good fit to live inside this monorepo, we still welcome you to create it and share with the ecosystem.
30
-
Reach out in a [Discussion](https://github.com/solidjs/solid-start/discussions) in the **showcase**session and we'll amplify as much as we can!
30
+
Reach out in a [Discussion](https://github.com/solidjs/solid-start/discussions) in the **showcase**section and we'll amplify as much as we can!
31
31
32
32
## Found a Bug
33
33
@@ -42,21 +42,21 @@ Create a **minimal** reproduction either in a remote IDE or in an open-source re
42
42
43
43
We recommend using the `create-solid` package with the **basic** setting.
You can also fork this repository and go to `apps/tests`.
56
56
There we have an app with all default configurations and many routes.
57
57
Create a new route, a Cypress assertion to it and open a PR with the failing test-case.
58
58
59
-
Once the PR is there, **create an issue** and link the PR (mention the PR as you'd mention a person in the issue description and vice-versa).
59
+
Once the PR is there, **create an issue** and link the PR (mention the PR as you'd mention a person in the issue description and viceversa).
60
60
61
61
> [!IMPORTANT]
62
62
> Mark the **allow edit by the maintainers** so we can more easily investigate the failing test and propose a fix. Otherwise we may need to close your PR and cherry-pick your commit.
- For building apps with SolidStart, check the [package README](/packages/start/README.md) and our [official docs](https://docs.solidjs.com/solid-start)
13
14
- For contributing to codebase, check [CONTRIBUTING.md](/CONTRIBUTING.md)
14
-
- For creating a new template, please head on to [solidjs/templates](https://github.com/solidjs/templates)
15
-
- For instructions on building with SolidStart, check the [package README.md](/packages/start/README.md) and our [official docs](https://docs.solidjs.com/solid-start)
15
+
- For creating a new template, please head over to [solidjs/templates](https://github.com/solidjs/templates)
16
16
17
17
## Prerequisites
18
18
19
-
-**Node.js**: Use the version specified in `.nvmrc`, to manage multiple versions across your system, we recommend a version manager such as [fnm](https://github.com/Schniz/fnm), or another of your preference.
19
+
-**Node.js**: Use the version specified in `.nvmrc`. To manage multiple versions across your system, we recommend a version manager such as [fnm](https://github.com/Schniz/fnm), or another of your choice.
20
20
-**pnpm**: Install globally via `npm install -g pnpm`. Or let **Corepack** handle it in the setup step below.
21
-
-**Git**: Ensure Git is installed for cloning and managing the repository
21
+
-**Git**: Ensure Git is installed for cloning and managing the repository.
22
22
23
23
## Monorepo Structure
24
24
25
-
SolidStart is a pnpm-based monorepo with nested workspaces. Key directories include
25
+
SolidStart is a pnpm-based monorepo with nested workspaces. Key directories include:
26
26
27
27
-**`packages/start`**: The core `@solidjs/start` package.
28
28
-**`apps/landing-page`**: The official landing page.
@@ -52,7 +52,7 @@ Use pnpm filters (e.g. `pnpm --filter @solidjs/start ...`) to target specific pa
52
52
pnpm dedupe
53
53
```
54
54
55
-
(`pnpm dedupe` will install dependencies _and_ clean the lockfile from duplicates, useful to preventing conflicts).
55
+
(`pnpm dedupe` will install dependencies _and_ clean the lockfile from duplicates, useful for preventing conflicts).
56
56
57
57
4. Build all packages and the landing page
58
58
```bash
@@ -69,7 +69,7 @@ Then reinstall dependencies and rebuild.
69
69
70
70
## Running Tests
71
71
72
-
End-to-end tests are located in `apps/tests` projects. For manual testing and development there's the `apps/fixtures` apps, and finally, integration and unit tests live inside their respective packages.
72
+
End-to-end tests are located in `apps/tests` projects. For manual testing and development use the `apps/fixtures` apps, and finally, integration and unit tests live inside their respective packages.
73
73
74
74
1. Install the Cypress binary (required only once)
0 commit comments