marcosgriselli/EasyTransitions

Add descriptions to objects and methods

開放

#9 建立於 2018年4月16日

在 GitHub 查看
 (0 則留言) (0 個反應) (0 位負責人)Swift (88 個分叉)github user discovery
enhancementgood first issue

倉庫指標

星標
 (1,656 顆星)
PR 合併指標
 (30 天內沒有已合併 PR)

描述

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.

貢獻者指南

研究方向
閱讀EasyTransitions程式碼庫以了解每個API元件，並為類別、結構體、列舉和方法添加Swift文件註解（///），說明其用途和用法。
技術棧
swift
領域
mobile
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1 小時以內
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
GitSwift
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80