This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new b5fe4a9a04 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)
b5fe4a9a04 is described below
commit b5fe4a9a044b8fc35e32b62236f8a75451665519
Author: Bruce Ritchie <[email protected]>
AuthorDate: Tue Jan 7 11:02:06 2025 -0500
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)
---
docs/source/contributor-guide/getting_started.md | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/docs/source/contributor-guide/getting_started.md
b/docs/source/contributor-guide/getting_started.md
index 5d85e07f3e..a4938ead43 100644
--- a/docs/source/contributor-guide/getting_started.md
+++ b/docs/source/contributor-guide/getting_started.md
@@ -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`.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
