Skip to content

Commit b5fe4a9

Browse files
authored
Added references to IDE documentation for dev containers along with a small note about why one may choose to do development using a dev container. (#14014)
1 parent f31ca5b commit b5fe4a9

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/source/contributor-guide/getting_started.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,18 @@ git-bash.exe
3030
cargo build
3131
```
3232

33+
## Dev Container setup
34+
35+
DataFusion has support for [dev containers](https://containers.dev/) which may be used for
36+
developing DataFusion in an isolated environment either locally or remote if desired. Using dev containers for developing
37+
DataFusion is not a requirement by any means but is available for those where doing local development could be tricky
38+
such as with Windows and WSL2, those with older hardware, etc.
39+
40+
For specific details on IDE support for dev containers see the documentation for [Visual Studio Code](https://code.visualstudio.com/docs/devcontainers/containers),
41+
[IntelliJ IDEA](https://www.jetbrains.com/help/idea/connect-to-devcontainer.html),
42+
[Rust Rover](https://www.jetbrains.com/help/rust/connect-to-devcontainer.html), and
43+
[GitHub Codespaces](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers).
44+
3345
## Protoc Installation
3446

3547
Compiling DataFusion from sources requires an installed version of the protobuf compiler, `protoc`.

0 commit comments

Comments
 (0)