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

Update CONTRIBUTING for checkstyle (#129333) 

It was out of date, telling folks to manually configure checkstyle. Or,
at least, it was implying they had to. They do not. It's all automatic.
This commit is contained in:
Nik Everett 2025-06-12 12:17:32 -04:00 committed by GitHub
parent 3988ee1935
commit e62e59c58e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
CONTRIBUTING.md
View File

@ -168,16 +168,13 @@ You can import the Elasticsearch project into IntelliJ IDEA via:
#### Checkstyle
If you have the [Checkstyle] plugin installed, you can configure IntelliJ to
check the Elasticsearch code. However, the Checkstyle configuration file does
not work by default with the IntelliJ plugin, so instead an IDE-specific config
file is generated automatically after IntelliJ finishes syncing. You can
manually generate the file with `./gradlew configureIdeCheckstyle` in case
it is removed due to a `./gradlew clean` or other action.
IntelliJ should automatically configure checkstyle. It does so by running
`configureIdeCheckstyle` on import. That makes `.idea/checkstyle-idea.xml`
configuration file. IntelliJ points checkstyle at that.
IntelliJ should be automatically configured to use the generated rules after
import via the `.idea/checkstyle-idea.xml` configuration file. No further
action is required.
Things like `./gradlew clean` or `git clean -xdf` can nuke the file. You can
regenerate it by running `./gradlew -Didea.active=true configureIdeCheckstyle`,
but generally shouldn't have to.
#### Formatting