badges/shields

Enhance Sonar Badges

Open

#3236 opened on Mar 26, 2019

View on GitHub
 (0 comments) (3 reactions) (0 assignees)JavaScript (22,337 stars) (5,423 forks)batch import
good first issueservice-badge

Description

:clipboard: Description We currently provide what I'll call "first class" badge support for a handful of Sonar metrics (code coverage, tech debt, violations, fortify rating, and documented api density).

However, Sonar provides a lot of other metrics (see: https://docs.sonarqube.org/latest/user-guide/metric-definitions/), and the SaaS offering of Sonar (https://sonarcloud.io/about) provides native badges for many of those other metrics.

We technically have badge support for all of those other metrics too, but it's what I'll call "second class" support where we simply display a brightgreen badge blue badge with the raw value (updated to reflect the change in the Sonar refactor in #3189).

For example, here's the native Sonar badge for security rating: Security Rating <-- (live badge) image <-- (bad screenshot I took to capture the state in case the underlying score changes)

And here's our corresponding badge for the exact same metric (https://img.shields.io/sonar/https/sonarcloud.io/com.luckybox:luckybox/security_rating.svg)

Let's add similar "first class" badge support for those other core Sonar metrics!

Contributor guide

Tech stack
javascriptnodejs
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with Node.jsUnderstanding of shields.io service architectureKnowledge of SonarQube metrics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the existing Sonar badge implementation in the repository, likely in a file like 'sonar.service.js'. Review the recent Sonar refactor pull request #3189 for context. Then, for each additional Sonar metric from the Sonar metrics documentation, implement first class badge support with appropriate color coding and thresholds, following the pattern of existing supported metrics.