[incubator-seatunnel] branch dev updated: add CheckStyle-IDEA Plugin introduction (#2535)

[ki...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

kirs pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-seatunnel.git


The following commit(s) were added to refs/heads/dev by this push:
     new 3ddec233a add CheckStyle-IDEA Plugin introduction (#2535)
3ddec233a is described below

commit 3ddec233a3069885f5bc14932e1f937c12a2f917
Author: Li Hongyu <lh...@gmail.com>
AuthorDate: Fri Aug 26 18:43:07 2022 +0800

    add CheckStyle-IDEA Plugin introduction (#2535)
    
    * add CheckStyle-IDEA Plugin introduction
    
    CheckStyle-IDEA Plugin
    
    * add pic and automatically format introduction
    
    Co-authored-by: bjyflihongyu <li...@jd.com>
---
 docs/en/contribution/setup.md |   8 ++++++++
 docs/en/images/checkstyle.png | Bin 0 -> 479660 bytes
 2 files changed, 8 insertions(+)

diff --git a/docs/en/contribution/setup.md b/docs/en/contribution/setup.md
index 5194a951d..2f1f31ae6 100644
--- a/docs/en/contribution/setup.md
+++ b/docs/en/contribution/setup.md
@@ -46,6 +46,14 @@ See [install plugins for IDEA](https://www.jetbrains.com/help/idea/managing-plug
 Before running the following example, you should also install JetBrains IntelliJ IDEA's [Lombok plugin](https://plugins.jetbrains.com/plugin/6317-lombok).
 See [install plugins for IDEA](https://www.jetbrains.com/help/idea/managing-plugins.html#install-plugins) if you want to.
 
+### Install JetBrains IDEA CheckStyle-IDEA Plugin
+
+Before coding, you should also install JetBrains IntelliJ IDEA's [CheckStyle-IDEA plugin](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea).
+See [install plugins for IDEA](https://www.jetbrains.com/help/idea/managing-plugins.html#install-plugins) if you want to.
+Next, you should go to `Preferences -> Editor -> Code style -> Scheme -> Import Scheme -> CheckStyle Configration` and import `tools/checkstyle/checkStyle.xml`
+![checkstyle.png](../images/checkstyle.png)
+If you want to change to automatically formatting, these configurations are also required.
+
 ## Run Simple Example
 
 After all the above things are done, you just finish the environment setup and can run an example we provide to you out
diff --git a/docs/en/images/checkstyle.png b/docs/en/images/checkstyle.png
new file mode 100644
index 000000000..4cf8303e7
Binary files /dev/null and b/docs/en/images/checkstyle.png differ