AbsaOSS/enceladus

Add scaladocs

Aperta

#63 aperta il 2 dic 2018

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Scala (16 fork)auto 404
ConformanceMenasStandardizationdocsgood first issuepriority: low

Metriche repository

Star
 (33 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina il codice per identificare le API prive di Scaladoc, poi scrivi commenti Scaladoc descrittivi seguendo le convenzioni del progetto.
Tech stack
scala
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
ScalaGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70