uber/RIBs

[Android] Need at least brief examples of libraries usage in their README's

Open

#236 opened on 2018年4月9日

GitHub で見る
 (0 comments) (5 reactions) (0 assignees)Kotlin (7,922 stars) (913 forks)batch import
Androiddocumentationhelp wanted

説明

Those libs are very confusing to be honest, it is hard to understand why we need to use them, and sometimes how, tutorials aren't covering them 100% and it takes considerable amount of time and effort to figure it out from sources

コントリビューターガイド

技術スタック
kotlinandroid
領域
mobiledocumentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
basic Android developmentunderstanding of RIBs architectureGitHub workflow
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85
調査方針
The issue requests adding brief usage examples for each library in their README. To proceed, first examine the current README at https://github.com/uber/RIBs/blob/master/android/README.md to identify which libraries are missing examples. Then, look at the source code in the android/ directory, particularly the sample apps (e.g., android/samples/) to understand typical usage patterns. A good approach is to add a simple code snippet for each library (e.g., how to create a RIB, attach/detach, etc.) in the README, following the existing style. No linked PRs or comments exist, so the work is independent.