leboncoin/spark-android

[FR]: Add module overview to README listing all modules

Open

#2,127 opened on Jul 27, 2026

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Kotlin (31 forks)auto 404
contribution welcomeddocumentationgood first issuepriority:LOW

Repository metrics

Stars
 (85 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe the problem

README.md does not mention spark-lint or spark-screenshot-testing modules. Consumers who want lint rules cannot find them.

Describe the solution

Add a module overview noting which modules are published (spark, spark-icons, spark-bom) and which are internal (spark-lint, spark-screenshot-testing, catalog).

Additional context

Priority: Low. Effort: XS.

Contributor guide

Research direction
Identify the existing modules in the repository and update README.md to list them under a module overview section, differentiating published and internal modules.
Tech stack
kotlinandroid
Domain
mobiledocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90