Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sashirestela authored Apr 9, 2024
1 parent 2317654 commit 1c3268b
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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

</details>
</details>

0 comments on commit 1c3268b

Please sign in to comment.