Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

SQ analyzes the software projects with respect to five main quality characteristics and their corresponding flaws:

  • reliability (bugs)
  • security (vulnerabilities)
  • security review (security hotspots)
  • maintainability (technical debt and code smells)
  • code coverage
  • duplications

...

The Overview screen lets one choose between the New Code tab and the Overall Code tab. Perhaps most importantly the Quality Gate Status (Passed or Failed) is being displayed in the top left corner. According to the official SQ documentation "a Quality Gate is a set of Boolean conditions based on measure thresholds against which projects are measured." Threshold examples are "No new blocker issues", "Code coverage on new code greater than 80%", ... Only if all conditions are met, the Quality Gate will be passed. Since the conditions can be freely adjusted, SQ allows to customize Quality Gates to developers' needs.

For each of these, SQ reports the number of flaws, a rating (from A to 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 below (as well as, in more detail, at the official SQ documentation).

...

Table Filter
inversefalse
sparkNameSparkline
hidePaneTable header
isNewfalse
separatorPoint (.)
labelsMaintainability rating
cell-width150
userfilterMaintainability rating
datepatternyy-mm-dd
id1643214224199
isORAND
formatVersion2
order0



Reliability ratingSecurity ratingMaintainability rating

Status
colourGreen
titleA

no bugsno vulnerabilitiestechnical debt ratio is less than 5%

Status
colourGreen
titleB

at least one minor bugat least one minor vulnerabilitytechnical debt ratio is less than 10%

Status
colourYellow
titleC

at least one major bugat least one major vulnerabilitytechnical debt ratio is less than 20%

Status
colourRed
titleD

at least one critical bugat least one critical vulnerabilitytechnical debt ratio is less than 50%

Status
colourRed
titleE

at least one blocker bugat least one blocker vulnerabilitytechnical 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.

...