docs: update CONTRIBUTING.md for IntelliJ and JDK 17 setup (Fixes #405) #455
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rexminnis
force-pushed
the
docs/fix-intellij-setup
branch
from
739f417 to
393a1c6
Compare
carsonwang
reviewed
Jan 27, 2026
| RayDP is a mixed-language project (Scala + Python). To set up your development environment correctly, please ensure your system meets the following requirements. | ||
|
|
||
| ### Prerequisites | ||
| * **Java:** JDK 8 (Required for Spark 3.x compatibility). |
Collaborator
There was a problem hiding this comment.
can you please also add information about JDK 17?
| 2. **Java SDK:** Ensure the project SDK is set to **Java 8**. | ||
| 3. **Python Sources:** The `python/` directory in the root must be marked as a source root so your IDE can resolve the `raydp` package. | ||
|
|
||
| ### Build & Verification |
Collaborator
There was a problem hiding this comment.
Can we use the project build.sh here which builds the core part and then the python part? If you want, add explanation how it works or the manual steps.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
Updated
CONTRIBUTING.mdto align the local development setup with the project's CI environment.Why are the changes needed?
The current CI workflow (
.github/workflows/raydp.yml) runs on JDK 17. The previous documentation recommended JDK 8, which causes "it works on my machine" issues when contributors submit code that passes locally but fails in CI due to version mismatches.Does this PR introduce any user-facing change?
No, this is a documentation-only change for developers.
How was this patch tested?
mvn clean package -DskipTeststo ensure the build succeeds with JDK 17.