Skip to content
Michel Pawlak edited this page Mar 14, 2017 · 5 revisions

Welcome to the Code Smells plugin wiki!

The Code Smells plugin for SonarQube allows developers to manually (i.e. during code reviews) report issues not seen by SonarQube but which should be taken into consideration when evaluating a project's technical debt. Read the project's rationale for more information and have a look at the example results page to see the kind of results the plugin provides.

You'll also find here how to install and configure the plugin, as well as information about supported SonarQube versions.

If you want to know how to use the plugin, please read first the how does it work and Maven dependency pages and have a look at the list of available Smells types. You'll be able then to report Code Smells directly in your source code.

There are unfortunately some known limitations. Make sure to read them before using the plugin. This may help you not waste your time.

Last but not least feel free to contribute to the project and thank you to all past contributors!