wix/Detox

[Maintenance] Split index.d.ts into sections

Open

#3,666 opened on Nov 4, 2022

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)JavaScript (1,942 forks)batch import
hacktoberfeststatus: acceptedtype: enhancement ⚡️user: looking for contributors

Repository metrics

Stars
 (10,558 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe your idea

@jonathanmos says regarding the main typings file, detox/index.d.ts:

This file is huge. Perhaps we should split it up to make it more manageable and import the sections?

Sounds like a good idea to me as well, Jonathan. Let's put that to the backlog, meanwhile.

Contributor guide

Research direction
Investigate the current structure of detox/index.d.ts and propose a modular split into separate files, then import them in the main index.
Tech stack
typescript
Domain
mobile dev
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70