Skip to content

Commit ab4c1db

Browse files
committed
Add initial config for devcontainers.
1 parent 0ebc64b commit ab4c1db

File tree

2 files changed

+34
-2
lines changed

2 files changed

+34
-2
lines changed

.devcontainer/devcontainer.json

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"name": "Node.js & TypeScript & Yarn",
3+
"image": "mcr.microsoft.com/devcontainers/typescript-node:1-22-bookworm",
4+
"features": {
5+
"ghcr.io/devcontainers/features/node:1": {}
6+
},
7+
"postCreateCommand": {
8+
"Install dependencies": "yarn install"
9+
}
10+
}

CONTRIBUTING.md

+24-2
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,30 @@ Please note that commit hooks will run automatically to perform some tasks;
3636
#### Windows users
3737

3838
Make sure your editor and terminal that run the tests are set to `Powershell 7` or above with
39-
`Git's Unix tools for Windows` installed. This is because some tests require you to be able to run `sh` and other
40-
unix commands.
39+
`Git's Unix tools for Windows` installed. This is because some tests require you to be able to run `sh` and other unix
40+
commands.
41+
42+
#### Development Containers
43+
44+
This project supports development containers (dev containers) which provide a consistent, pre-configured development
45+
environment. Using dev containers is recommended as it ensures all contributors work with the same development setup.
46+
47+
To use dev containers:
48+
49+
1. Install [Docker Desktop](https://www.docker.com/products/docker-desktop/)
50+
2. Install the
51+
[Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) in
52+
VS Code
53+
3. Clone the repository and open it in VS Code
54+
4. When prompted, click "Reopen in Container" or use the command palette (F1) and select "Dev Containers: Reopen in
55+
Container"
56+
57+
The dev container will automatically:
58+
59+
- Set up Node.js and TypeScript environment
60+
- Install project dependencies using Yarn
61+
62+
This eliminates the need to manually install Node.js, Yarn, and other dependencies on your local machine.
4163

4264
#### License
4365

0 commit comments

Comments
 (0)