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 3c1b59b [HUDI-2263] add steps for checkstyle (#3462)
3c1b59b is described below
commit 3c1b59b1fa9ddc95f5cf9bec1c518edd7cbf5b99
Author: Satish M <[email protected]>
AuthorDate: Mon Aug 16 19:44:15 2021 +0530
[HUDI-2263] add steps for checkstyle (#3462)
---
website/contribute/developer-setup.md | 15 ++++++++++++++-
.../images/contributing/IDE_setup_checkstyle_1.png | Bin 0 -> 323973 bytes
.../images/contributing/IDE_setup_checkstyle_2.png | Bin 0 -> 254971 bytes
.../images/contributing/IDE_setup_checkstyle_3.png | Bin 0 -> 277777 bytes
.../images/contributing/IDE_setup_checkstyle_4.png | Bin 0 -> 683055 bytes
5 files changed, 14 insertions(+), 1 deletion(-)
diff --git a/website/contribute/developer-setup.md
b/website/contribute/developer-setup.md
index a823eab..868eebd 100644
--- a/website/contribute/developer-setup.md
+++ b/website/contribute/developer-setup.md
@@ -26,8 +26,21 @@ 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)
-- \[Recommended\] We have embraced the code style largely based on [google
format](https://google.github.io/styleguide/javaguide). 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\] 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
+ * Install and activate CheckStyle plugin
+
+ * Open Preferences -> Tools -> checkstyle
+
+
+ * Change checkstyle version to 8.20
+
+
+ * Click on + and add the style/checkstyle.xml file
+
+
+ * 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.
diff --git
a/website/static/assets/images/contributing/IDE_setup_checkstyle_1.png
b/website/static/assets/images/contributing/IDE_setup_checkstyle_1.png
new file mode 100644
index 0000000..0c1d33a
Binary files /dev/null and
b/website/static/assets/images/contributing/IDE_setup_checkstyle_1.png differ
diff --git
a/website/static/assets/images/contributing/IDE_setup_checkstyle_2.png
b/website/static/assets/images/contributing/IDE_setup_checkstyle_2.png
new file mode 100644
index 0000000..08c04b4
Binary files /dev/null and
b/website/static/assets/images/contributing/IDE_setup_checkstyle_2.png differ
diff --git
a/website/static/assets/images/contributing/IDE_setup_checkstyle_3.png
b/website/static/assets/images/contributing/IDE_setup_checkstyle_3.png
new file mode 100644
index 0000000..a1909a1
Binary files /dev/null and
b/website/static/assets/images/contributing/IDE_setup_checkstyle_3.png differ
diff --git
a/website/static/assets/images/contributing/IDE_setup_checkstyle_4.png
b/website/static/assets/images/contributing/IDE_setup_checkstyle_4.png
new file mode 100644
index 0000000..a85d2e1
Binary files /dev/null and
b/website/static/assets/images/contributing/IDE_setup_checkstyle_4.png differ
