This is an automated email from the ASF dual-hosted git repository.
sivabalan pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/hudi.git
The following commit(s) were added to refs/heads/asf-site by this push:
new ca8c6879f75 [DOCS] Improve Developer Setup page (#9208)
ca8c6879f75 is described below
commit ca8c6879f75c597257e6078f6fd6fc94311fa540
Author: Y Ethan Guo <[email protected]>
AuthorDate: Fri Aug 4 21:35:13 2023 -0700
[DOCS] Improve Developer Setup page (#9208)
---
website/contribute/developer-setup.md | 18 ++++++++++--------
1 file changed, 10 insertions(+), 8 deletions(-)
diff --git a/website/contribute/developer-setup.md
b/website/contribute/developer-setup.md
index 5ca759250d6..4b80cee3e15 100644
--- a/website/contribute/developer-setup.md
+++ b/website/contribute/developer-setup.md
@@ -20,32 +20,34 @@ To contribute code, you need
- (Recommended) Join our dev mailing list & slack channel, listed on
[community](/community/get-involved) page.
-## IDE Setup
+## IntelliJ Setup
-To contribute, you would need to do the following
+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)
+- 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 `Project Structure`, select Java 1.8 as the Project SDK
+- 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
+ * Enable annotation processing in compiler.

- * Configure Maven *NOT* to delegate IDE build/run actions to Maven so you
can run tests in IntelliJ directly
+ * 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
+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 Project Preferences in IDE
+ * Open Project Preferences in IntelliJ
* Install and activate CheckStyle plugin
