leboncoin/spark-android

[FR]: Add catalog/README.md

Open

#2,131 opened on Jul 27, 2026

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Kotlin (31 forks)auto 404
catalog-appcontribution welcomeddocumentationgood first issuepriority:LOW

Repository metrics

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

Description

Describe the problem

The catalog module is a full Android application with configurators and examples but has no README. Its purpose is undiscoverable without reading CONTRIBUTING.md.

Describe the solution

Add a two-paragraph catalog/README.md explaining what the app is, how to run it (./gradlew :catalog:installDebug), and where configurators vs examples live.

Additional context

Priority: Low. Effort: XS.

Contributor guide

Research direction
Read the project's CONTRIBUTING.md to understand the structure, then create a catalog/README.md file that describes the module, provides build instructions (./gradlew :catalog:installDebug), and explains where configurators and examples are located.
Tech stack
kotlinandroid
Domain
documentationmobile
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.
Under 1 hour
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85