-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add: documentation pages for suspicious metrics and risk profile #2963
- Loading branch information
Showing
2 changed files
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
|
||
permalink: /docs/suspicious-metrics/ | ||
title: "Suspicious metrics" | ||
|
||
This feature compares the values of different metrics with metric values of 241 Open Source Java projects. | ||
Based on this data suspicious and inconspicuous metrics are identified and corresponding suggestions can be clicked to view them. | ||
|
||
Be aware that metrics for other programming languages might not be comparable to Java Reference metric values. | ||
|
||
To activate this function it is necessary to open the global configuration menu and activate the experimental features, | ||
after that the Suspicious button will appear in the main menu. Pressing this button will open the suspicious metrics panel. | ||
Here are listed the suspicious metrics, you can change the map view with the suspicious metrics buttons, you can also see | ||
highlighted on the map the files with a high risk factor (if any). | ||
|
||
> Icons by [fontawesome](https://fontawesome.com/icons?d=gallery&q=arrows) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
|
||
permalink: /docs/risk-profile/ | ||
title: "Risk profile" | ||
|
||
The Risk Profile gives a quick overview about the complexity and risk structure of the code base. It tells you how much | ||
of the code is placed in files associated with low/high risk in means of maintainability. | ||
|
||
The separation of code in risk classes like low or high complexity is based on Java reference metric values and therefore | ||
can be inaccurate for other programming languages. | ||
|
||
To activate this function it is necessary to open the global configuration menu and activate the experimental features, | ||
after that the Risk profile button will appear in the main menu. Pressing this button will open the risk profile panel. | ||
Here you will find listed the code percentages separated by their complexity. | ||
|
||
> Icons by [fontawesome](https://fontawesome.com/icons?d=gallery&q=arrows) |