marcosgriselli/EasyTransitions

Add descriptions to objects and methods

Open

#9 opened on Apr 16, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Swift (88 forks)github user discovery
enhancementgood first issue

Repository metrics

Stars
 (1,656 stars)
PR merge metrics
 (No merged PRs in 30d)

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.

Contributor guide

Research direction
Read the EasyTransitions codebase to understand each API component and add Swift documentation comments (///) to classes, structs, enums, and methods explaining their purpose and usage.
Tech stack
swift
Domain
mobile
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitSwift
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80