marcosgriselli/EasyTransitions

Add descriptions to objects and methods

Aberta

#9 aberto em 16 de abr. de 2018

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)Swift (88 forks)github user discovery
enhancementgood first issue

Métricas do repositório

Stars
 (1.656 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

In order to have a well documented API we need to describe what each class, struct, enum and method responsibilities are and how to use it.

Guia do colaborador

Direção de pesquisa
Leia o código do EasyTransitions para entender cada componente da API e adicione comentários de documentação Swift (///) a classes, structs, enums e métodos explicando seu propósito e uso.
Pilha de tecnologia
swift
Domain
mobile
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.
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
GitSwift
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80