luckyframework/avram

Add inline documentation

Aperta

#35 aperta il 4 dic 2017

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Crystal (67 fork)auto 404
good first issue

Metriche repository

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

Descrizione

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!

Guida contributor

Direzione di ricerca
Leggi le convenzioni di documentazione di Crystal indicate nell'issue, poi scegli un metodo pubblico e aggiungi la documentazione inline seguendo tali convenzioni.
Tech stack
Nessuno
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
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
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85