Skip to content

Commit 6b9761f

Browse files
committed
docs: clarify devcontainer workflows
1 parent 41de2d4 commit 6b9761f

1 file changed

Lines changed: 14 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,20 @@ Thanks for helping improve `contentful.java`.
66

77
This repository includes a `.devcontainer` configuration for a reproducible local setup. GitHub Actions uses the same devcontainer configuration for CI.
88

9-
1. Install Docker and a devcontainer-compatible editor. Visual Studio Code with the Dev Containers extension works well.
10-
2. Open the repository in the dev container and wait for the post-create setup to finish.
11-
3. Verify the environment:
9+
### Visual Studio Code
10+
11+
Open the repository in Visual Studio Code, install the Dev Containers extension if needed, then run `Dev Containers: Reopen in Container`. Wait for the container build and post-create setup to finish.
12+
13+
### Terminal or other editors
14+
15+
Install Docker and the Dev Container CLI (`npm install -g @devcontainers/cli`). From the repository root, run:
16+
17+
```bash
18+
devcontainer up --workspace-folder .
19+
devcontainer exec --workspace-folder . bash
20+
```
21+
22+
### Verify the environment
1223

1324
```bash
1425
./mvnw -B test

0 commit comments

Comments
 (0)