uber/RIBs

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

Open

#236 opened on Apr 9, 2018

View on GitHub
 (0 comments) (5 reactions) (0 assignees)Kotlin (7,922 stars) (913 forks)batch import
Androiddocumentationhelp wanted

Description

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

Contributor guide

Tech stack
kotlinandroid
Domain
mobiledocumentation
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Android developmentunderstanding of RIBs architectureGitHub workflow
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
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.