Expand documentation with work principals

Open
#3 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
Half a day
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
android, java

Research direction

Start by reading README.MD and inspect the Android-Secure-Storage component to understand its current behavior. Expand the README to explain why and how it works, including its limitations; the work is done when these topics are clearly documented for users.

Written by the indexing model from the issue text.

Description

The README.MD should describe why and how this component works, what are the limitations and so on.

Dominant language
Java
Stars
27
Forks
5
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from epam/Android-Secure-Storage

All issues in epam/Android-Secure-Storage

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.