Developer Guide: Clarify instructions for setting up Checkstyle-IDEA

Alaru · Aug 3, 2017 · eec2a5f · eec2a5f
1 parent 2084731
commit eec2a5f
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/docs/DeveloperGuide.adoc b/docs/DeveloperGuide.adoc
@@ -54,12 +54,18 @@ Restart the IDE to complete the installation.
 === Configuring Checkstyle-IDEA
 
 . Click `File` > `Settings...` > `Other Settings` > `Checkstyle`
+. Set `Scan Scope`  to `Only Java sources (including tests)`, so that the plugin will run checkstyle for our test source codes as well
+. Ensure that the `Checkstyle version` is set to `8.1`. This is the same version that we are using inside Gradle, so that you won't get any errors due to version incompatibility
++
+image::checkstyle-idea-scan-scope.png[width="500"]
 . Click the plus sign under `Configuration File`
 . Enter an arbitrary description e.g. addressbook
 . Select `Use a local Checkstyle file`
 . Use the checkstyle configuration file found at `config/checkstyle/checkstyle.xml`
 . Click `Next` > `Finish`
 . Mark `Active` for the newly imported check configuration
++
+image::checkstyle-idea-configuration.png[width="700"]
 . Click `OK`
 
 === Updating documentation

diff --git a/docs/images/checkstyle-idea-configuration.png b/docs/images/checkstyle-idea-configuration.png
diff --git a/docs/images/checkstyle-idea-scan-scope.png b/docs/images/checkstyle-idea-scan-scope.png