ossf/scorecard-webapp

Include docs for API in the website

Aperta

#209 aperta il 18 set 2022

Vedi su GitHub
 (4 commenti) (0 reazioni) (1 assegnatario)Go (30 fork)auto 404
documentationenhancementgood first issuehelp wanted

Metriche repository

Star
 (29 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

The website doesn't have docs for the new API.

https://securityscorecards.dev/#run-the-checks

Guida contributor

Direzione di ricerca
Aggiungi la documentazione dell'API al sito seguendo la struttura esistente. Fai riferimento al codice sorgente dell'API per dettagli accurati. Crea una nuova pagina o sezione e assicurati che i link funzionino.
Tech stack
go
Dominio
backendapi
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85