LeoColman/Petals

Create a guide/gif/pdf on how to use the app displaying the main features and their purposes

Open

#204 opened on Dec 29, 2022

View on GitHub
 (5 comments) (0 reactions) (1 assignee)Kotlin (39 forks)auto 404
FeatureGood First Issue

Repository metrics

Stars
 (122 stars)
PR merge metrics
 (PR metrics pending)

Description

In order to present Petals as a healthy choice and to indeed be a healthy choice, we need to show it to the world. One way of doing that is showing screenshots, which is static and not enough to visualize everything. Another way is to show to the person face-to-face, but that's not scalable and won't reach much people.

We need something designed to show how the app works, why the features are there and as an invite to get to know it better. We should be able to show this 'brochure' to

  • Potential users
  • Researchers that want to understand the project
  • Media/press

Contributor guide

Research direction
Explore the app by running it on an emulator or device. Identify all main features (e.g., tracking usage, setting goals, viewing statistics). Capture screenshots or record a GIF/video for each feature. Design a visual guide (PDF or GIF) that explains the purpose of each screen and how to use it.
Tech stack
kotlin
Domain
mobile
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitAndroid Studio (or emulator)
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80