leboncoin/spark-android

[FR]: Standardise generator script invocation syntax across docs

Closed

#2,124 opened on Jul 27, 2026

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

Repository metrics

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

Description

Describe the problem

COMPONENT_CREATION_GUIDE says kotlin scripts/generate-component.main.kts. CONTRIBUTING.md says ./scripts/generate-component.main.kts. Both work, but the inconsistency confuses contributors.

Describe the solution

Standardise on ./scripts/generate-component.main.kts (simpler, matches CONTRIBUTING.md).

Additional context

Priority: Low. Effort: XS.

Contributor guide

Research direction
Search the repository for all instances of the generator script invocation (`./scripts/generate component.main.kts` or `kotlin scripts/generate component.main.kts`) in documentation files. Update each to use `./scripts/generate component.main.kts`.
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80