docs: update CONTRIBUTING.md for IntelliJ and JDK 17 setup (Fixes #405)#455
docs: update CONTRIBUTING.md for IntelliJ and JDK 17 setup (Fixes #405)#455rexminnis wants to merge 4 commits intoray-project:masterfrom
Conversation
rexminnis
force-pushed
the
docs/fix-intellij-setup
branch
from
739f417 to
393a1c6
Compare
CONTRIBUTING.md
Outdated
| 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). |
There was a problem hiding this comment.
can you please also add information about JDK 17?
There was a problem hiding this comment.
Done — updated to mention both JDK 8 and JDK 17, with a recommendation to use 17 to match CI.
| 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 |
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.
There was a problem hiding this comment.
Done — added build.sh as the primary build method with an explanation, and kept the manual steps as an alternative.
|
The CI failure in |
2 participants
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.