guardianproject/haven

Please clarify what the external libraries are used for?

Open

#120 opened on Dec 25, 2017

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Java (6,509 stars) (747 forks)batch import
enhancementhelp wanted

Description

The build.gradle contain quite a lot of dependencies on external libraries. As a privacy project, it would make sense to more clearly explain in the README (or linked elsewhere) why these are used and for what. I.e. Why can they be trusted?

Contributor guide

Tech stack
javaandroid
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
read build.gradleunderstand privacy concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate the dependencies listed in the `build.gradle` file. For each external library, research its purpose and why it is used in Haven. Update the README (or create a new document) to explain each dependency's role and how it respects user privacy. Reference the existing comments on the issue for any maintainer input.