luckyframework/avram

Add inline documentation

Ouverte

#35 ouverte le 4 déc. 2017

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Crystal (67 forks)auto 404
good first issue

Métriques du dépôt

Stars
 (180 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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!

Guide contributeur

Direction de recherche
Lisez les conventions de documentation de Crystal liées dans le problème, puis choisissez une méthode publique et ajoutez de la documentation en ligne conformément à ces conventions.
Stack technique
Aucun
Domaine
backend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85