leboncoin/spark-android

[FR]: Add catalog/README.md

Aperta

#2131 aperta il 27 lug 2026

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Kotlin (31 fork)auto 404
catalog-appcontribution welcomeddocumentationgood first issuepriority:LOW

Metriche repository

Star
 (85 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Leggi CONTRIBUTING.md del progetto per comprendere la struttura, quindi crea un file catalog/README.md che descriva il modulo, fornisca le istruzioni di build (./gradlew :catalog:installDebug) e spieghi dove si trovano configuratori ed esempi.
Tech stack
kotlinandroid
Dominio
documentationmobile
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85