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
+14-2Lines changed: 14 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -69,7 +69,7 @@ You need to have these tools up and running in your local machine:
69
69
- one of the following:
70
70
-[Nix](https://nixos.org)
71
71
-[Docker](https://www.docker.com/)
72
-
- Locally installed NodeJS v18+ and optionally Rust
72
+
- Locally installed NodeJS v22+ and optionally Rust
73
73
74
74
#### Nix
75
75
@@ -95,6 +95,15 @@ Alternatively you can use [devcontainers/cli](https://github.com/devcontainers/c
95
95
- In your terminal navigate to the Qwik's project root directory.
96
96
- Then run `devcontainer up --workspace-folder .`. This command will start a Docker container with all required environment dependencies.
97
97
98
+
> [!TIP]
99
+
> If you are using Podman, be sure to update the [VSCode dev container settings](https://code.visualstudio.com/remote/advancedcontainers/docker-options#_podman). Don't forget to allocate enough resources to the Podman machine to avoid slow builds.
100
+
101
+
> [!NOTE]
102
+
> You may run into an `EEXISTS` error when the Dev Container runs the "updateContentCommand" script. This may happen if pnpm gets installed automatically during the setup process. You can ignore the error because the container will be setup correctly, then run `pnpm install` in the project root once the container is connected and the terminal is available.
103
+
104
+
> [!CAUTION]
105
+
> The Dev Container may not work on Windows properly due to a difference with Windows container host volume permissions and ownership. It's recommended to use Mac or Linux instead, or configure your environment to build the project without Dev Containers.
106
+
98
107
##### Using development container without Dev Containers and VSCode
99
108
100
109
If you would like to make use of the development container solution, but don't use VSCode or Dev Containers, you still can do so, by following steps:
@@ -145,7 +154,7 @@ Furthermore, to build the optimizer you optionally need Rust.
145
154
146
155
1. Make sure [Rust](https://www.rust-lang.org/tools/install) is installed.
147
156
2. Install [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/) with `cargo install wasm-pack` .
148
-
3. Node version >= `18`.
157
+
3. Node version >= `22`.
149
158
4. Make sure you have [pnpm](https://pnpm.io/installation) installed.
0 commit comments