diff --git a/documentation/developer/building.md b/documentation/developer/building.md index 84163fc7f..2e35e634b 100644 --- a/documentation/developer/building.md +++ b/documentation/developer/building.md @@ -48,3 +48,16 @@ git clone git@github.com:igniterealtime/Smack.git cd Smack gradle assemble ``` + +IDE Config +---------- + +### Eclipse + +Import IDE settings from `./resources/eclipse/` to configure proper ordering of imports and correct formatting that should pass the CheckStyle rules. + +### IntelliJ IDEA + +Import Java Code Style settings from `./resources/intellij/smack_formatter.xml` to configure import optimisation and code formatting to pass the CheckStyle rules when building or submitting PRs. + +_We've noticed, at time of writing, that IntelliJ often requires a restart when applying new rules - no amount of OK/Apply will do the trick._ diff --git a/resources/intellij/Smack Import Order.xml b/resources/intellij/Smack Import Order.xml deleted file mode 100644 index 3209e4f5f..000000000 --- a/resources/intellij/Smack Import Order.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - - - diff --git a/resources/intellij/smack_formatter.xml b/resources/intellij/smack_formatter.xml new file mode 100644 index 000000000..961dda2b6 --- /dev/null +++ b/resources/intellij/smack_formatter.xml @@ -0,0 +1,51 @@ + + \ No newline at end of file