leboncoin/spark-android

[FR]: Add legacy-pattern callout in COMPONENT_CREATION_GUIDE.md

Closed

#2,118 opened on Jul 27, 2026

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Kotlin (31 forks)auto 404
contribution welcomeddocumentationgood first issuepriority:MEDIUM

Repository metrics

Stars
 (85 stars)
PR merge metrics
 (Avg merge 4d 9h) (73 merged PRs in 30d)

Description

Describe the problem

The guide documents the object-with-variant-methods pattern as the standard. Many existing components (Tags, Buttons) use per-variant top-level functions. Contributors studying existing code see a pattern the guide does not describe.

Describe the solution

Add a note near the architecture section stating that existing components may use a legacy pattern (per-variant top-level functions) and that new components should follow the object pattern.

Additional context

Priority: Medium. Effort: XS.

Contributor guide

Research direction
Locate the architecture section in COMPONENT CREATION GUIDE.md and add a note explaining that existing components may use a legacy pattern (per variant top level functions) and that new components should follow the object pattern.
Tech stack
kotlin
Domain
documentation
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.
85