marcosgriselli/EasyTransitions

Add descriptions to objects and methods

Offen

#9 geöffnet am 16.04.2018

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Swift (88 Forks)github user discovery
enhancementgood first issue

Repository-Metriken

Stars
 (1.656 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Lesen Sie die EasyTransitions Codebasis, um jede API Komponente zu verstehen, und fügen Sie Swift Dokumentationskommentare (///) zu Klassen, Strukturen, Aufzählungen und Methoden hinzu, die deren Zweck und Verwendung erklären.
Tech Stack
swift
Domain
mobile
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitSwift
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80