ossf/scorecard-webapp

Feature - Human readable report to link to from scorecards badge

Open

#206 opened on Sep 9, 2022

View on GitHub
 (15 comments) (7 reactions) (1 assignee)Go (30 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (29 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem? Please describe. No, this is a feature request for generating a human readable report rather than printing json when clicking on the scorecard badge. Describe the solution you'd like Clicking on the scorecard badge redirects to json output e.g. link. It would be great if a human readable version could be generated from the json.

Describe alternatives you've considered N/A

Additional context Users clicking on the scorecard badge need to manually parse the json to understand what the project score means.

Contributor guide

Research direction
Examine the API endpoint that serves the JSON scorecard and design a new endpoint that returns an HTML representation.
Tech stack
go
Domain
backend
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75