Message-ID: <1519733330.1827.1419106866114.JavaMail.firstname.lastname@example.org> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_1826_1450443661.1419106866113" ------=_Part_1826_1450443661.1419106866113 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
If you're managing your technical debt using SonarQube's issue workflow,= then you probably want to manage all your technical debt wit= h that workflow. But even after you've enabled the rules that flag duplicat= ed blocks, insufficient branch coverage by unit tests, insufficient comment= density, and insufficient line coverage by unit tests (these rules in the = "Common Sonar" repository are available to all languages) there w= ill still be problems in your code that SonarQube can't catch.
For instance you might come across a laborious re-implementation of some= function that's already offered by a library you're using. Even though the= re may be nothing technically wrong with the code (except ignorance or shee= r bone-headedness) you want to flag it for remediation. That's where manual= issues come in to play.
You can create all the manual rules you want, and they can be about anyt= hing you choose. In this case, the rule might be "use library function= ." Or, if that's too narrow and specific, you might create a simple &q= uot;refactor" rule. When you create individual issues against the rule= , you'll have the opportunity to fill in the details of the specific instan= ce. "Use library function X", in this case.
To create a manual issue, you must be logged in and have the
Manual issues are logged against m= anual rules. (Note that manual= rules have to be previously defined by a System administrator.) Choose the= rule to use from the rule dropdown and enter the issue message in the text= area: (Once created, you cannot = edit the rule or description of a manual issue.)
The issue is then displayed within=
the source code and can be reviewed as any other issues:
Note that just as you manually cre= ated the issue, you will need to manually resolve it. Since SonarQube did n= ot detect it originally, it cannot detect when it has been corrected.
A user with the "Administer Quality Profiles and Gates" permi= ssion can create new manual rules and administer existing ones in the = Rules page:
As for any other rule, it descript= ion can be written using the Markdown syntax.
The description you enter is used = as the rule detail:
Manual Rules can be found in the R= ules page by selecting the "Manual Rules" repository.