ossf/scorecard-webapp

Include docs for API in the website

Aberta

#209 aberto em 18 de set. de 2022

Ver no GitHub
 (4 comentários) (0 reação) (1 responsável)Go (30 forks)auto 404
documentationenhancementgood first issuehelp wanted

Métricas do repositório

Stars
 (29 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

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

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

Guia do colaborador

Direção de pesquisa
Adicione a documentação da API ao site seguindo a estrutura de documentação existente. Consulte o código fonte da API para obter detalhes precisos. Crie uma nova página ou seção e garanta que os links funcionem.
Pilha de tecnologia
go
Domain
backendapi
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitMarkdown
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85