...
For each of these, SQ reports the number of flaws, a rating (from A , B, C, D, and Eto E, with A being the highest / "best" score) for this characteristic, and a link to a trend diagram. Each of the reported information can be clicked and directs the user to more detailed analysis and/or diagrams for this value. The definition of the ratings as provided by SQ is described in the Rating Table.table below (as well as, in more detail, at the official SQ documentation).
| Reliability rating | Security rating | Maintainability rating | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| no bugs | no vulnerabilities | technical debt ratio is less than 5% | |||||||
| at least one minor bug | at least one minor vulnerability | technical debt ratio is less than 10% | |||||||
| at least one major bug | at least one major vulnerability | technical debt ratio is less than 20% | |||||||
| at least one critical bug | at least one critical vulnerability | technical debt ratio is less than 50% | |||||||
| at least one blocker bug | at least one blocker vulnerability | technical debt ratio is higher than 50% |
SQ reports separately the overall numbers and the values for new code (i.e., for the code developed since previous analysis in SQ). That helps in getting the general insight into the project status, and tracking the trends.
...
Users can also comment on the issue and assign labels/tags to it. The recommendations on how to use these elements are provided here.
In addition, SQ reports an estimated remediation effort, showing the time required to adequately address and fix the issue.
By clicking on an issue, a reviewer can get a contextual description that includes the affected code snippet, with marked subject areas and recommendation provided by SQ rule that identified the issue. For example, code duplications may span across several locations in the code; SQ identifies and marks each of them, so that it is easier to spot them and evaluate their actual impact on the affected quality characteristic.
...
By default, SQ presents an overview (a diagram showing the relevance and priority of the issues, and the trend showing changes between consecutive scans made by SQ) and the aggregated lists of analyzed files affected by the specific type of issue. That helps in performing a more thorough analysis, restricted to a specific type of issue, and targeted at uncovering the root cause of it.In addition, SQ for each quality characteristic reports also its rating, calculated based according to the SQ schema (from A to E, with A being the highest / "best" score) and estimated remediation effort, showing the time required to adequately address and fix the issue. A detailed description of the ratings are described in the Rating Table.
Code screen
The Code screen acts as a formatted preview of the recent code snapshot analyzed by SQ, grouped by the packages. The screen provides also line numbers, the commits that recently changed a given line (including the author, data and commit id). Next, it indicates lines covered by unit tests (in green) and not covered (in red).
...