marcosgriselli/EasyTransitions

Add descriptions to objects and methods

Aperta

#9 aperta il 16 apr 2018

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Swift (88 fork)github user discovery
enhancementgood first issue

Metriche repository

Star
 (1656 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Leggi il codebase di EasyTransitions per comprendere ogni componente dell'API e aggiungi commenti di documentazione Swift (///) a classi, struct, enum e metodi spiegando il loro scopo e utilizzo.
Tech stack
swift
Dominio
mobile
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitSwift
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80