luckyframework/avram

Add inline documentation

Aberta

#35 aberto em 4 de dez. de 2017

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)Crystal (67 forks)auto 404
good first issue

Métricas do repositório

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

Description

Inline documentation was purposely left off when things were changing, but now the API is starting to stabilize. Adding documentation to the public facing methods would be fantastic.

If you'd like to help, here is how Crystal docs work: https://crystal-lang.org/docs/conventions/documenting_code.html

Feel free to make small PRs so it's easy to review and merge them in :D

Thanks so much for the help!

Guia do colaborador

Direção de pesquisa
Leia as convenções de documentação do Crystal vinculadas na issue, depois escolha um método público e adicione documentação inline seguindo essas convenções.
Pilha de tecnologia
None
Domain
backend
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
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85