badges/shields

Badge Request: Codiga - Code Quality Score

Open

#8,624 opened on Nov 13, 2022

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

Description

:clipboard: Description

  • service: Codiga
  • information: code quality score
  • example: Code Quality Score | 97

:link: Data

:microphone: Motivation

It would be nice to show a code quality score from Codiga in a readme or on a website via shields such that the style of the badge can be similar to other badges.

Contributor guide

Tech stack
javascriptrest api
Domain
developer experienceanalytics
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic JavaScriptUnderstanding of Shields.io badge creation processFamiliarity with REST APIs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review existing badge service implementations in the `services/` directory of the Shields.io repository to understand the pattern. Implement a new service for Codiga using the provided API documentation at https://doc.codiga.io/docs/api/api code analysis/. The service should fetch the code quality score for a given project and render a badge. Ensure to handle API keys for private projects as per the issue description. Reference the issue comments for any discussion on implementation details.