You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@datafusion.apache.org by "dentiny (via GitHub)" <gi...@apache.org> on 2025/02/16 07:31:19 UTC
[PR] docs: Add instruction to build [datafusion]
dentiny opened a new pull request, #14694:
URL: https://github.com/apache/datafusion/pull/14694
## Which issue does this PR close?
- Closes https://github.com/apache/datafusion/issues/14681
## Rationale for this change
Add better instruction for new-comers to build the project.
## Are these changes tested?
I manually verified the build steps work on my end.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: Add instruction to build [datafusion]
Posted by "comphead (via GitHub)" <gi...@apache.org>.
comphead merged PR #14694:
URL: https://github.com/apache/datafusion/pull/14694
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: Add instruction to build [datafusion]
Posted by "dentiny (via GitHub)" <gi...@apache.org>.
dentiny commented on code in PR #14694:
URL: https://github.com/apache/datafusion/pull/14694#discussion_r1957718072
##########
docs/source/contributor-guide/index.md:
##########
@@ -216,3 +216,23 @@ The good thing about open code and open development is that any issues in one ch
Pull requests will be marked with a `stale` label after 60 days of inactivity and then closed 7 days after that.
Commenting on the PR will remove the `stale` label.
+
+## Building
Review Comment:
I removed instructions for build, they're already included in the existing dev env doc;
Keep some sentence for setting dev container for easier operation.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: Add instruction to build [datafusion]
Posted by "comphead (via GitHub)" <gi...@apache.org>.
comphead commented on code in PR #14694:
URL: https://github.com/apache/datafusion/pull/14694#discussion_r1958646842
##########
docs/source/contributor-guide/development_environment.md:
##########
@@ -37,6 +37,22 @@ developing DataFusion in an isolated environment either locally or remote if des
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.
+To open the project in vscode you will need the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). For codespaces you will need to [create a new codespace](https://github.com/apache/datafusion).
Review Comment:
thanks @dentiny for your contribution
Couple of notes
- referring to VSCode probably can be misleading as not all engineers using it.
- Not sure why dev containers are needed for the development
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: Add instruction to build [datafusion]
Posted by "dentiny (via GitHub)" <gi...@apache.org>.
dentiny commented on code in PR #14694:
URL: https://github.com/apache/datafusion/pull/14694#discussion_r1957260006
##########
docs/source/contributor-guide/index.md:
##########
@@ -216,3 +216,23 @@ The good thing about open code and open development is that any issues in one ch
Pull requests will be marked with a `stale` label after 60 days of inactivity and then closed 7 days after that.
Commenting on the PR will remove the `stale` label.
+
+## Building
+
+- To build the project, run `cargo build`; to run all the tests, run `cargo test`.
+- One external dependency `protoc` is needed, please install it before build and make sure both executable and protobuf definition accessible
+
+## Dev Container / Github Codespaces
Review Comment:
I referenced https://github.com/Mooncake-Labs/pg_mooncake/blob/main/CONTRIBUTING.md#dev-container--github-codespaces
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: Add instruction to build [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #14694:
URL: https://github.com/apache/datafusion/pull/14694#issuecomment-2684699147
I think we forgot to update the index name too:
- https://github.com/apache/datafusion/pull/14890
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: Add instruction to build [datafusion]
Posted by "dentiny (via GitHub)" <gi...@apache.org>.
dentiny commented on PR #14694:
URL: https://github.com/apache/datafusion/pull/14694#issuecomment-2662225775
> I have some other thought on making this easier to find. What do you think?
Both sounds good to me!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: Add instruction to build [datafusion]
Posted by "dentiny (via GitHub)" <gi...@apache.org>.
dentiny commented on code in PR #14694:
URL: https://github.com/apache/datafusion/pull/14694#discussion_r1966652960
##########
docs/source/contributor-guide/development_environment.md:
##########
@@ -37,6 +37,22 @@ developing DataFusion in an isolated environment either locally or remote if des
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.
+To open the project in vscode you will need the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). For codespaces you will need to [create a new codespace](https://github.com/apache/datafusion).
Review Comment:
> referring to VSCode probably can be misleading as not all engineers using it.
Ok, I will remove. Add it because vscode is pretty popular.
> Not sure why dev containers are needed for the development
Devcontainer is a easy-setup datafusion provides, otherwise you need to manually prepare a clean environment.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: Add instruction to build [datafusion]
Posted by "dentiny (via GitHub)" <gi...@apache.org>.
dentiny commented on code in PR #14694:
URL: https://github.com/apache/datafusion/pull/14694#discussion_r1957683279
##########
docs/source/contributor-guide/index.md:
##########
@@ -216,3 +216,23 @@ The good thing about open code and open development is that any issues in one ch
Pull requests will be marked with a `stale` label after 60 days of inactivity and then closed 7 days after that.
Commenting on the PR will remove the `stale` label.
+
+## Building
Review Comment:
> I think most of this information is already present in this page:
Ohhhh my bad! I didn't find it's the subpage for contributing page...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: Add instruction to build [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #14694:
URL: https://github.com/apache/datafusion/pull/14694#discussion_r1957300909
##########
docs/source/contributor-guide/index.md:
##########
@@ -216,3 +216,23 @@ The good thing about open code and open development is that any issues in one ch
Pull requests will be marked with a `stale` label after 60 days of inactivity and then closed 7 days after that.
Commenting on the PR will remove the `stale` label.
+
+## Building
Review Comment:
Thank you @dentiny -- I think most of this information is already present in this page:
https://datafusion.apache.org/contributor-guide/getting_started.html
Would you be willing to combine your contribution with the existing information there?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: Add instruction to build [datafusion]
Posted by "dentiny (via GitHub)" <gi...@apache.org>.
dentiny commented on code in PR #14694:
URL: https://github.com/apache/datafusion/pull/14694#discussion_r1966653578
##########
docs/source/contributor-guide/index.md:
##########
@@ -216,3 +216,23 @@ The good thing about open code and open development is that any issues in one ch
Pull requests will be marked with a `stale` label after 60 days of inactivity and then closed 7 days after that.
Commenting on the PR will remove the `stale` label.
+
+## Building
Review Comment:
In the latest commit, I remove those unrelated.
##########
docs/source/contributor-guide/index.md:
##########
@@ -216,3 +216,23 @@ The good thing about open code and open development is that any issues in one ch
Pull requests will be marked with a `stale` label after 60 days of inactivity and then closed 7 days after that.
Commenting on the PR will remove the `stale` label.
+
+## Building
Review Comment:
In the latest commit, I remove those unrelated.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org