marcosgriselli/EasyTransitions

Add descriptions to objects and methods

Ouverte

#9 ouverte le 16 avr. 2018

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)Swift (88 forks)github user discovery
enhancementgood first issue

Métriques du dépôt

Stars
 (1 656 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Lisez la base de code d'EasyTransitions pour comprendre chaque composant de l'API et ajoutez des commentaires de documentation Swift (///) aux classes, structures, énumérations et méthodes expliquant leur objectif et leur utilisation.
Stack technique
swift
Domaine
mobile
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.
2
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
GitSwift
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80