uber/RIBs

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

Open

#236 创建于 2018年4月9日

在 GitHub 查看
 (0 评论) (5 反应) (0 负责人)Kotlin (7,922 star) (913 fork)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
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
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.