autonomousapps/dependency-analysis-gradle-plugin

Add documentation on how to setup dev environment for Android development (to run tests)

Open

#430 opened on Jun 25, 2021

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Kotlin (154 forks)auto 404
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (2,172 stars)
PR merge metrics
 (PR metrics pending)

Description

The functionalTest suite has a number of Android specs that assume a dev environment suitable for them to run in. For any current or former Android developer, this is trivial, as they would have installed all the necessary tools since time immemorial. For non-Android JVM developers, this means they cannot run the full test suite. They can run all the JVM tests with ./gradlew funcTest --tests com.autonomousapps.jvm.*, but the Android tests remain a bridge too far.

The Wiki and/or the readme should be updated with instructions on how to use the command-line sdkmanager to install the necessary tools from a clean slate.

This would be a good first issue for any Android developer who would like to help out :)

Contributor guide

Research direction
Research how to use the command line sdkmanager to install Android SDK components from a clean slate, then write clear step by step instructions for the Wiki or README. Focus on what a non Android developer would need to run the full test suite.
Tech stack
kotlinandroid
Domain
devtools
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Android SDKCommand line
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80