leboncoin/spark-android

[FR]: Add catalog/README.md

Ouverte

#2 131 ouverte le 27 juil. 2026

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Kotlin (31 forks)auto 404
catalog-appcontribution welcomeddocumentationgood first issuepriority:LOW

Métriques du dépôt

Stars
 (85 étoiles)
Métriques de merge PR
 (Merge moyen 4j 9h) (73 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Lisez le CONTRIBUTING.md du projet pour comprendre la structure, puis créez un fichier catalog/README.md qui décrit le module, fournit les instructions de build (./gradlew :catalog:installDebug) et explique où se trouvent les configurateurs et les exemples.
Stack technique
kotlinandroid
Domaine
documentationmobile
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85