From 1c3268b0cdd5d5b7fc926c76470cfaa7cb06a5b7 Mon Sep 17 00:00:00 2001 From: Sashir Estela Date: Tue, 9 Apr 2024 12:01:09 -0500 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 35cbce5..f0c6572 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,6 +19,10 @@ Spotless comes with two Maven commands that you can run at any moment, preferabl The remote build will check the code formatting, so the build will fail if the code isn't formatted correctly. +## Static Analysis +This project is configured to use [SonarCloud](https://sonarcloud.io) for static analysis. That analysis runs after every pull request to the `main` branch and the results can be examined in the project [dashboard](https://sonarcloud.io/project/overview?id=sashirestela_cleverclient). + +It is highly recommended you install the free [SonarLint](https://sonarlint.io) extension in your favorite IDE, so you can analyze your code in advance before your pull request. ## Configure IDE (Optional) You could set your favorite IDE to be aligned to the custom code format. See details below. @@ -100,4 +104,4 @@ You could set your favorite IDE to be aligned to the custom code format. See det - Number of imports needed for .*: 99 - Number of static imports needed for .*: 99 - \ No newline at end of file +