leboncoin/spark-android

[FR]: Add catalog/README.md

Aberta

#2.131 aberto em 27 de jul. de 2026

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)Kotlin (31 forks)auto 404
catalog-appcontribution welcomeddocumentationgood first issuepriority:LOW

Métricas do repositório

Stars
 (85 estrelas)
Métricas de merge de PR
 (Mesclagem média 4d 9h) (73 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Leia o CONTRIBUTING.md do projeto para entender a estrutura, então crie um arquivo catalog/README.md que descreva o módulo, forneça instruções de construção (./gradlew :catalog:installDebug) e explique onde os configuradores e exemplos estão localizados.
Pilha de tecnologia
kotlinandroid
Domain
documentationmobile
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85