badges/shields

Enhance TeamCity Coverage Badge

Open

#3111 opened on Feb 27, 2019

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

Description

:clipboard: Description

Enhance the TeamCity Coverage Badge to allow the user to specify the coverage metric (lines, statements, etc.) they want to use via a param.

Our current badge implementation is keying off statement coverage, but while I was working on resolving https://github.com/badges/shields/issues/2901 I noticed that a lot (actually the majority) of TeamCity projects with coverage did not have statement coverage (most had line coverage long with method/function, and others).

If we allowed the user to specify their target coverage metric (we can still default to statement) then we can make the coverage badge for TeamCity available to a much broader set of users

Contributor guide

Tech stack
javascriptnodejs
Domain
developer experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
Node.js experienceShields codebase familiarity
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the existing TeamCity coverage badge implementation in the Shields codebase. Identify where the coverage metric is currently hardcoded to 'statement'. Add support for a query parameter (e.g., `metric`) that allows users to specify 'line', 'statement', etc., defaulting to 'statement'. Refer to linked issue #2901 for context on how other coverage badges handle this.