xushiyan commented on code in PR #14251: URL: https://github.com/apache/hudi/pull/14251#discussion_r2651730497
########## website/contribute/developer-setup.md: ########## @@ -156,17 +111,71 @@ Use `alt use` to use v1 version of docker-compose while running integration test This Quick Video will give a code walkthrough to start with [watch](https://www.youtube.com/watch?v=N2eDfU_rQ_U). + +## IntelliJ Setup Review Comment: this section has a lot of screenshots and it'll be too long to properly scroll. pick items and make them collapsible ########## website/contribute/developer-setup.md: ########## @@ -16,61 +16,16 @@ To contribute code, you need - for large contributions, a signed [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf) (ICLA) to the Apache Software Foundation (ASF). - (Recommended) Join our dev mailing list & slack channel, listed on [community](/community/get-involved) page. +## Default Build Profiles -## IntelliJ Setup - -IntelliJ is the recommended IDE for developing Hudi. To contribute, you would need to do the following - -- Fork the Hudi code on Github & then clone your own fork locally. Once cloned, we recommend building as per instructions on [spark quickstart](/docs/quick-start-guide) or [flink quickstart](/docs/flink-quick-start-guide). - -- In IntelliJ, select `File` > `New` > `Project from Existing Sources...` and select the `pom.xml` file under your local Hudi source folder. - -- In `Project Structure`, select Java 1.8 as the Project SDK. - -  - -- Make the following configuration in `Preferences` or `Settings` in newer IntelliJ so the Hudi code can compile in the IDE: - * Enable annotation processing in compiler. - -  - * Configure Maven *NOT* to delegate IDE build/run actions to Maven so you can run tests in IntelliJ directly. - -  -  - -- If you switch maven build profile, e.g., from Spark 3.2 to Spark 3.3, you need to first build Hudi in the command line first and `Reload All Maven Projects` in IntelliJ like below, -so that IntelliJ re-indexes the code. - -  - -- \[Recommended\] We have embraced the code style largely based on [google format](https://google.github.io/styleguide/javaguide.html). Please set up your IDE with style files from [\<project root\>/style/](https://github.com/apache/hudi/tree/master/style). These instructions have been tested on IntelliJ. - * Open `Settings` in IntelliJ - * Install and activate CheckStyle plugin +The following table summarizes the default build profiles and versions used by the Apache Hudi project. -  - * In `Settings` > `Tools` > `Checkstyle`, use a recent version, e.g., 10.17.0 - -  - * Click on `+`, add the style/checkstyle.xml file, and name the configuration as "Hudi Checks" - -  - * Activate the checkstyle configuration by checking `Active` - -  - * Open `Settings` > `Editor` > `Code Style` > `Java` - * Select "Project" as the "Scheme". Then, go to the settings, open `Import Scheme` > `CheckStyle Configuration`, select `style/checkstyle.xml` to load - -  - * After loading the configuration, you should see that the `Indent` and `Continuation indent` become 2 and 4, from 4 and 8, respectively - -  - * Apply/Save the changes -- \[Recommended\] Set up the [Save Action Plugin](https://plugins.jetbrains.com/plugin/7642-save-actions) to auto format & organize imports on save. The Maven Compilation life-cycle will fail if there are checkstyle violations. - -- \[Recommended\] As it is required to add [Apache License header](https://www.apache.org/legal/src-headers#headers) to all source files, configuring "Copyright" settings as shown below will come in handy. - - - +| Component | Default Profile / Version | Notes | +|----------|--------------------------|-------| +| Spark | 3.5 | Default Spark 3 build profile | +| Scala | 2.12 | Default Scala version for Spark builds | +| Java | 11 | Recommended and CI-aligned Java version | +| Flink | 1.20 | Default Flink streaming profile | Review Comment: add these version info to master branch readme the notes col is redundant -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
