uber/RIBs

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

Open

#236 geöffnet am 9. Apr. 2018

Auf GitHub ansehen
 (0 Kommentare) (5 Reaktionen) (0 zugewiesene Personen)Kotlin (7.922 Stars) (913 Forks)batch import
Androiddocumentationhelp wanted

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
basic Android developmentunderstanding of RIBs architectureGitHub workflow
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85
Research-Richtung
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.