ossf/scorecard-webapp

Include docs for API in the website

Ouverte

#209 ouverte le 18 sept. 2022

Voir sur GitHub
 (4 commentaires) (0 réaction) (1 personne assignée)Go (30 forks)auto 404
documentationenhancementgood first issuehelp wanted

Métriques du dépôt

Stars
 (29 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

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

Guide contributeur

Direction de recherche
Ajoutez la documentation de l'API au site en suivant la structure de documentation existante. Référez vous au code source de l'API pour des détails précis. Créez une nouvelle page ou section et assurez vous que les liens fonctionnent.
Stack technique
go
Domaine
backendapi
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85