uber/RIBs

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

Open

#236 ouverte le 9 avr. 2018

Voir sur GitHub
 (0 commentaires) (5 réactions) (0 assignés)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

Guide contributeur

Stack technique
kotlinandroid
Domaine
mobiledocumentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
basic Android developmentunderstanding of RIBs architectureGitHub workflow
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85
Direction de recherche
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.