0chain / 0chain/HelloWorld-iOS

documentation 📄

オープン
#4 コメント 0 件 リアクション 0 件 担当者 1 名 @vijay-kachhadiya が担当を希望しています GitHub で見る
documentation
主要言語
Objective-C
スター
0
フォーク
1
PR マージ指標
30日以内にマージされた PR はありません

説明

add documentation of entire application.
- methods should have parameter documentation
- swift closures should be closing brace indictor
- extensions should have examples
- models should have every variable documented

references:
https://sarunw.com/posts/swift-documentation/

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

このissueは、iOSアプリケーション全体にわたる包括的なドキュメントを求めています。まず、リポジトリの構造を探索し、特にモデル、メソッド、エクステンション、クロージャなどの主要なファイルを特定します。提供されているSwiftドキュメントガイドを参考にしてください。既存のコードをチェックしてパターンを確認し、例に従ってドキュメントを追加します。すべての変数、パラメータ、クロージャがドキュメント化されていること、またエクステンションには使用例が含まれていることを確認してください。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
objective-c, swift
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
30/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。