Bjoren/ResearchMap

Document API in wiki

Aberta

#25 aberto em 23 de mai. de 2019

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)JavaScript (0 fork)auto 404
enhancementgood first issuequality assurance

Métricas do repositório

Stars
 (0 estrela)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

The API endpoints and data models should be documented and maintained in the git wiki.

Guia do colaborador

Direção de pesquisa
Examine a implementação da API existente no código e crie uma página wiki documentando os endpoints, formatos de solicitação/resposta e modelos de dados.
Pilha de tecnologia
javascript
Domain
backenddocumentation
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.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90