This is an automated email from the ASF dual-hosted git repository.
vinoyang 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 9ae1abd [DOC] Add more details to IDE setup (#1896)
9ae1abd is described below
commit 9ae1abd5c35d13c2cd4c116d94d97e1c856b4910
Author: Raymond Xu <[email protected]>
AuthorDate: Wed Aug 5 05:50:18 2020 -0700
[DOC] Add more details to IDE setup (#1896)
---
docs/_pages/contributing.md | 24 +++++++++++++++------
.../images/contributing/IDE_setup_copyright_1.png | Bin 0 -> 710312 bytes
.../images/contributing/IDE_setup_copyright_2.png | Bin 0 -> 581227 bytes
.../images/contributing/IDE_setup_maven_1.png | Bin 0 -> 608854 bytes
.../images/contributing/IDE_setup_maven_2.png | Bin 0 -> 588765 bytes
5 files changed, 18 insertions(+), 6 deletions(-)
diff --git a/docs/_pages/contributing.md b/docs/_pages/contributing.md
index eca5ee8..00301ae 100644
--- a/docs/_pages/contributing.md
+++ b/docs/_pages/contributing.md
@@ -24,11 +24,23 @@ To contribute code, you need
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
[quickstart](/docs/quick-start-guide.html)
- - [Recommended] We have embraced the code style largely based on [google
format](https://google.github.io/styleguide/javaguide.html). Please setup your
IDE with style files from
[here](https://github.com/apache/hudi/tree/master/style).
-These instructions have been tested on IntelliJ.
- - [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.
- - [Optional] If needed, add spark jars to the classpath of your module in
Intellij by following the steps from
[here](https://stackoverflow.com/questions/1051640/correct-way-to-add-external-jars-lib-jar-to-an-intellij-idea-project).
+- Fork the Hudi code on Github & then clone your own fork locally. Once
cloned, we recommend building as per instructions on
[quickstart](/docs/quick-start-guide.html)
+
+- \[Recommended\] We have embraced the code style largely based on [google
format](https://google.github.io/styleguide/javaguide.html). Please setup your
IDE with style files from [\<project
root\>/style/](https://github.com/apache/hudi/tree/master/style). These
instructions have been tested on IntelliJ.
+
+- \[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.html#headers) to all source
files, configuring "Copyright" settings as shown below will come in handy.
+
+
+
+
+- \[Optional\] If needed, add spark jars to the classpath of your module in
Intellij by following the steps from
[here](https://stackoverflow.com/questions/1051640/correct-way-to-add-external-jars-lib-jar-to-an-intellij-idea-project).
+
+- \[Optional\] You may configure IntelliJ to respect maven CLI and pom.xml
settings.
+
+
+
## Accounts and Permissions
@@ -166,4 +178,4 @@ Discussion about contributing code to Hudi happens on the
[dev@ mailing list](co
## Website
[Apache Hudi site](https://hudi.apache.org) is hosted on a special `asf-site`
branch. Please follow the `README` file under `docs` on that branch for
-instructions on making changes to the website.
\ No newline at end of file
+instructions on making changes to the website.
diff --git a/docs/assets/images/contributing/IDE_setup_copyright_1.png
b/docs/assets/images/contributing/IDE_setup_copyright_1.png
new file mode 100644
index 0000000..0430f7e
Binary files /dev/null and
b/docs/assets/images/contributing/IDE_setup_copyright_1.png differ
diff --git a/docs/assets/images/contributing/IDE_setup_copyright_2.png
b/docs/assets/images/contributing/IDE_setup_copyright_2.png
new file mode 100644
index 0000000..53a7ac7
Binary files /dev/null and
b/docs/assets/images/contributing/IDE_setup_copyright_2.png differ
diff --git a/docs/assets/images/contributing/IDE_setup_maven_1.png
b/docs/assets/images/contributing/IDE_setup_maven_1.png
new file mode 100644
index 0000000..6e500e1
Binary files /dev/null and
b/docs/assets/images/contributing/IDE_setup_maven_1.png differ
diff --git a/docs/assets/images/contributing/IDE_setup_maven_2.png
b/docs/assets/images/contributing/IDE_setup_maven_2.png
new file mode 100644
index 0000000..a6f9950
Binary files /dev/null and
b/docs/assets/images/contributing/IDE_setup_maven_2.png differ
