commit | c3aa9b6062316f64d1491237dc5444a80d1b5e38 | [log] [tgz] |
---|---|---|
author | wudongliang <46414265+DongLiang-0@users.noreply.github.com> | Fri Dec 15 14:37:12 2023 +0800 |
committer | GitHub <noreply@github.com> | Fri Dec 15 14:37:12 2023 +0800 |
tree | 2b5a941d9f1bc676e13efb06f005280d83269b44 | |
parent | f60bebf4c18a5dc5cca3aaa7ca0c17dc74384f64 [diff] |
[step3][doc]add document for code style (#273)
Flink Doris Connector now support flink version from 1.11 to 1.18.
If you wish to contribute or use a connector from flink 1.13 (and earlier), please use the branch-for-flink-before-1.13
More information about compilation and usage, please visit Flink Doris Connector
You need to copy customer_env.sh.tpl to customer_env.sh before build and you need to configure it before build.
git clone git@github.com:apache/doris-flink-connector.git cd doris-flink-connector/flink-doris-connector ./build.sh
You need to install the google-java-format plugin. Spotless together with google-java-format is used to format the codes.
It is recommended to automatically format your code by applying the following settings:
For earlier IntelliJ IDEA versions, the step 4 to 7 will be changed as follows.
.*\.java
to avoid formatting other file types. Then the whole project could be formatted by command mvn spotless:apply
.Checkstyle is used to enforce static coding guidelines.
tools/maven/checkstyle.xml
which is located within your cloned repository.checkstyle.suppressions.file
with the value suppressions.xml
and click “Next”.You can now import the Checkstyle configuration for the Java code formatter.
tools/maven/checkstyle.xml
located within your cloned repository.Then you could click “View” → “Tool Windows” → “Checkstyle” and find the “Check Module” button in the opened tool window to validate checkstyle. Or you can use the command mvn clean compile checkstyle:checkstyle
to validate.
If you find any bugs, feel free to file a GitHub issue or fix it by submitting a pull request.
Contact us through the following mailing list.
Name | Scope | |||
---|---|---|---|---|
dev@doris.apache.org | Development-related discussions | Subscribe | Unsubscribe | Archives |