ossf/scorecard-webapp

Include docs for API in the website

Offen

#209 geöffnet am 18.09.2022

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Go (30 Forks)auto 404
documentationenhancementgood first issuehelp wanted

Repository-Metriken

Stars
 (29 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

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

Contributor Guide

Research-Richtung
Fügen Sie die API Dokumentation zur Website hinzu, indem Sie der vorhandenen Dokumentationsstruktur folgen. Beachten Sie den API Quellcode für genaue Details. Erstellen Sie eine neue Seite oder einen neuen Abschnitt und stellen Sie sicher, dass die Links funktionieren.
Tech Stack
go
Domain
backendapi
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85