Skip to content

Commit

Permalink
Added references to IDE documentation for dev containers along with a…
Browse files Browse the repository at this point in the history
… small note about why one may choose to do development using a dev container. (#14014)
  • Loading branch information
Omega359 authored Jan 7, 2025
1 parent f31ca5b commit b5fe4a9
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/source/contributor-guide/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,18 @@ git-bash.exe
cargo build
```

## Dev Container setup

DataFusion has support for [dev containers](https://containers.dev/) which may be used for
developing DataFusion in an isolated environment either locally or remote if desired. Using dev containers for developing
DataFusion is not a requirement by any means but is available for those where doing local development could be tricky
such as with Windows and WSL2, those with older hardware, etc.

For specific details on IDE support for dev containers see the documentation for [Visual Studio Code](https://code.visualstudio.com/docs/devcontainers/containers),
[IntelliJ IDEA](https://www.jetbrains.com/help/idea/connect-to-devcontainer.html),
[Rust Rover](https://www.jetbrains.com/help/rust/connect-to-devcontainer.html), and
[GitHub Codespaces](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers).

## Protoc Installation

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

0 comments on commit b5fe4a9

Please sign in to comment.