leboncoin/spark-android

[FR]: Add catalog/README.md

开放

#2,131 创建于 2026年7月27日

在 GitHub 查看贡献者指南
 (0 条评论) (0 个反应) (0 位负责人)Kotlin (31 个派生)auto 404
catalog-appcontribution welcomeddocumentationgood first issuepriority:LOW

仓库指标

星标
 (85 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

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.

贡献者指南

研究方向
阅读项目的CONTRIBUTING.md以了解结构，然后创建一个catalog/README.md文件，描述模块、提供构建说明（./gradlew :catalog:installDebug），并解释配置器和示例的位置。
技术栈
kotlinandroid
领域
documentationmobile
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1 小时以内
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
新近可参与
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85