leboncoin/spark-android

[FR]: Add catalog/README.md

Offen

#2.131 geöffnet am 27.07.2026

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Kotlin (31 Forks)auto 404
catalog-appcontribution welcomeddocumentationgood first issuepriority:LOW

Repository-Metriken

Stars
 (85 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 4T 9h) (73 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Lesen Sie die CONTRIBUTING.md des Projekts, um die Struktur zu verstehen, und erstellen Sie dann eine Datei catalog/README.md, die das Modul beschreibt, Build Anweisungen (./gradlew :catalog:installDebug) bereitstellt und erklärt, wo Konfiguratoren und Beispiele zu finden sind.
Tech Stack
kotlinandroid
Domain
documentationmobile
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85