linkedin / linkedin/LiTr

Detailed documentation is needed for this great android library !!

Open
#141 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
663
Forks
92
PR merge metrics
No merged PRs in 30d

Description

Hi LinkedIn team, you guys are doing awesome by open sourcing some of the great projects, we are thankful to you for all your efforts. Just a small feedback on this android lib - **It would be better if you can provide a detailed documentation of this project, it will help us to get to know which class / object is responsible for what.**

Thanks a lot !

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

The issue does not identify any files, tests, or entry points. Start by surveying the LiTr project and its existing documentation to map the classes and objects that need explanation; the work is done when the library has detailed documentation describing those responsibilities.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, java
Domain
documentation, mobile
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.