From 4ccbcba3a6ac3be2766a7d0dba9df6740b2429df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Vorburger=20=E2=9B=91=EF=B8=8F?= Date: Sat, 28 Mar 2020 15:28:38 +0100 Subject: [PATCH] add Eclipse Checkstyle plugin tip to README --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3b5d610a4..e0887eef6 100644 --- a/README.md +++ b/README.md @@ -110,9 +110,10 @@ and the `mysqlserver` environment variable is now no longer supported.)_ Checkstyle ============ -This project enforces [its code conventions](fineract-provider/config/checkstyle/checkstyle.xml) using Checkstyle. +This project enforces its code conventions using [checkstyle.xml](fineract-provider/config/checkstyle/checkstyle.xml). It is configured to run automatically during the normal Gradle build, and fail if there are any style violations detected. We recommend that you configure your favourite Java IDE to match those conventions. For Eclipse, you can File > Import > General > Preferences our [config/fineractdev-eclipse-preferences.epf](config/fineractdev-eclipse-preferences.epf). +You could also use Checkstyle directly in your IDE (but you don't neccesarily have to, it may just be more convenient for you). For Eclipse, use https://checkstyle.org/eclipse-cs/ and load our checkstyle.xml into it. Version