Skip to content

Commit 71f5751

Browse files
committed
fixup! doc: update devcontainer.json and add documentation
1 parent 0406320 commit 71f5751

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

doc/contributing/using-devcontainer.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
# Developing Node.js using Dev Containers
22

3-
[Dev Containers](https://containers.dev/) allows development inside a containerized environment, ensuring
4-
consistency across different development setups.
5-
6-
Node.js provides a [nightly Dev Container image](https://hub.docker.com/r/nodejs/devcontainer) that can
7-
be used to set up a development environment quickly and enable incremental compilation based on nightly builds.
8-
Most of the times, if you only have some changes in the main branch and do not need to change the V8 headers
9-
(which is rare), using the nightly image will allow you to compile your changes from a fresh checkout
10-
in a few seconds instead of spending tens of minutes or even hours to compile the entire codebase from scratch.
3+
Node.js publishes a [nightly image on DockerHub](https://hub.docker.com/r/nodejs/devcontainer) for
4+
[Dev Containers](https://containers.dev/) that can be used to spin up a
5+
development container that comes with pre-installed build dependencies and pre-genreated build cache.
6+
7+
When you need to test a few changes in the main branch and do not need
8+
to change the V8 headers (which is rare), using the nightly image will allow you to compile your
9+
changes from a fresh checkout quickly without having to compile the entire codebase, especially V8,
10+
from scratch.
11+
1112
The Dev Container also allows you to test your changes in a different operating system, and to test
1213
third-party code from bug reports safely with your work-in-progress Node.js branches in an isolated environment.
1314

14-
This guide will walk you through the steps to set up a Dev Container for Node.js development using
15-
[Visual Studio Code (VS Code)](https://code.visualstudio.com/).
15+
There are many command line tools, IDEs and services that [support Dev Containers](https://containers.dev/supporting).
16+
Among them, [Visual Studio Code (VS Code)](https://code.visualstudio.com/) is a very popuplar option.
17+
This guide will walk you through the steps to set up a Dev Container for Node.js development using VS Code.
18+
You should be able to use the same [`nodejs/devcontainer:nightly` image](https://hub.docker.com/r/nodejs/devcontainer)
19+
in other tools and services using generally similar steps.
1620

1721
## Prerequisites
1822

0 commit comments

Comments
 (0)