AbsaOSS/enceladus

Add scaladocs

Aberta

#63 aberto em 2 de dez. de 2018

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)Scala (16 forks)auto 404
ConformanceMenasStandardizationdocsgood first issuepriority: low

Métricas do repositório

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

Description

We lack scaladocs on most APIs, would really help to improve documentation.

Guia do colaborador

Direção de pesquisa
Revise o código para identificar APIs sem Scaladoc e escreva comentários Scaladoc descritivos seguindo as convenções do projeto.
Pilha de tecnologia
scala
Domain
documentation
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.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
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
ScalaGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70