uber / uber/RIBs

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

Open
#236 0 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Android documentation help wanted
Dominant language
Kotlin
Stars
7.9k
Forks
914
PR merge metrics
No merged PRs in 30d

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by identifying the Android libraries and their README files covered by this request. Read the existing tutorials and README content to determine which usage and purpose examples are missing. Done means each relevant README includes a brief example that makes the library's purpose and basic usage easier to understand.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, kotlin
Domain
documentation, mobile
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.