root
/
kafka
mirror of https://github.com/apache/kafka.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity

MINOR: Clarify Spotless instructions in README.md (#16471) 

Reviewers: Igor Soarez <soarez@apple.com>
This commit is contained in:
Omnia Ibrahim 2024-06-27 12:04:08 +01:00 committed by GitHub
parent 49e9bd4a5b
commit c2de7c5e54
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -232,11 +232,15 @@ You can run checkstyle using:
The checkstyle warnings will be found in `reports/checkstyle/reports/main.html` and `reports/checkstyle/reports/test.html` files in the The checkstyle warnings will be found in `reports/checkstyle/reports/main.html` and `reports/checkstyle/reports/test.html` files in the
subproject build directories. They are also printed to the console. The build will fail if Checkstyle fails. subproject build directories. They are also printed to the console. The build will fail if Checkstyle fails.
**Please note that `./gradlew spotlessCheck` currently has an issue with Java 21 (see https://github.com/diffplug/spotless/pull/1920), so make sure to run this with JDK 11 or 17**
#### Spotless #### #### Spotless ####
The import order is a part of static check. please call `spotlessApply` (require JDK 11+) to optimize the imports of Java codes before filing pull request. The import order is a part of static check. please call `spotlessApply` (require JDK 11+) to optimize the imports of Java codes before filing pull request.
./gradlew spotlessApply ./gradlew spotlessApply
**Please note that `./gradlew spotlessApply` currently has an issue with Java 21 (see https://github.com/diffplug/spotless/pull/1920), so make sure to run this with JDK 11 or 17**
#### Spotbugs #### #### Spotbugs ####
Spotbugs uses static analysis to look for bugs in the code. Spotbugs uses static analysis to look for bugs in the code.
You can run spotbugs using: You can run spotbugs using: