Skip to content

Commit 1919e6b

Browse files
authored
Merge pull request #7769 from kamranayub/kamranayub/contributing
fix: Update Dev Container and CONTRIBUTING guidelines
2 parents 1f018d1 + 2815179 commit 1919e6b

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

.devcontainer/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM cimg/rust:1.73-node
1+
FROM cimg/rust:1.88.0-node
22

33
RUN rustup --version; \
44
cargo --version; \

CONTRIBUTING.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ You need to have these tools up and running in your local machine:
6969
- one of the following:
7070
- [Nix](https://nixos.org)
7171
- [Docker](https://www.docker.com/)
72-
- Locally installed NodeJS v18+ and optionally Rust
72+
- Locally installed NodeJS v22+ and optionally Rust
7373

7474
#### Nix
7575

@@ -95,6 +95,15 @@ Alternatively you can use [devcontainers/cli](https://github.com/devcontainers/c
9595
- In your terminal navigate to the Qwik's project root directory.
9696
- Then run `devcontainer up --workspace-folder .`. This command will start a Docker container with all required environment dependencies.
9797

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+
98107
##### Using development container without Dev Containers and VSCode
99108

100109
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.
145154

146155
1. Make sure [Rust](https://www.rust-lang.org/tools/install) is installed.
147156
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`.
149158
4. Make sure you have [pnpm](https://pnpm.io/installation) installed.
150159
5. run `pnpm install`
151160

@@ -164,6 +173,9 @@ pnpm install && pnpm build.local
164173

165174
If you want to work on the Rust code, use `build.full` instead of `build.local`.
166175

176+
> [!NOTE]
177+
> After running `build.local`, you may see Git diffs for API-related files and `JSXNode`. You should run the `api.update` script to resolve them.
178+
167179
### Fast build
168180

169181
This will build only Qwik and Qwik City and their types. This is not enough to run the docs.

0 commit comments

Comments
 (0)