docs: update onboardings docs for CheckStyle (#6855)

I have encountered some problems with Checkstyle as described here: checkstyle/eclipse-cs#190 Setting the version used by plugin to 8.18 is a good fix until I understand who depends on the CheckStyle XML and how I can fix it. I have also sorted checkstyle.properties so it is easier to copy it into the editor plugin configuration
confluentinc · Jan 12, 2021 · 1f57dbd · 1f57dbd
1 parent d044d64
commit 1f57dbd
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -79,6 +79,8 @@ You can set up IntelliJ for CheckStyle. First install the CheckStyle IDEA plugin
 
     IntelliJ → Preferences → Tools → CheckStyle
 
+    In top left corner select CheckStyle version 8.18 (newer versions fail to parse the provided XML)
+
     - Add a new configurations file using the '+' button:
        Description: Confluent Checks
        URL: https://raw.githubusercontent.com/confluentinc/common/master/build-tools/src/main/resources/checkstyle/checkstyle.xml

diff --git a/checkstyle/checkstyle.properties b/checkstyle/checkstyle.properties
@@ -14,10 +14,10 @@
 # specific language governing permissions and limitations under the License.
 #
 
-checkstyle.hideutilityclassconstructor.severity=error
-checkstyle.redundantmodifier.severity=error
 checkstyle.customimportorder.severity=error
 checkstyle.finalclass.severity=error
-checkstyle.finalparameters.severity=error
 checkstyle.finallocalvariable.severity=error
+checkstyle.finalparameters.severity=error
+checkstyle.hideutilityclassconstructor.severity=error
+checkstyle.redundantmodifier.severity=error
 checkstyle.todocomment.severity=error