SolidOS / SolidOS/solid-ui

Clean up API

Aperta
#120 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement
Lingua principale
TypeScript
Stelle
153
Fork
46
Merge medio
1g 8h
PR unite (30g)
7

Descrizione

Some methods are currently a bit misplaced and hence become more difficult for people to discover for people unbeknownst to solid-ui.

I suggest that at some point we do some analysis of the current API (especially the methods in widgets/button, which contains a lot of lower-level functionality that doesn't necessarily pertain to buttons at all) to move some methods around to "proper" namespaces.

The challenge with this is to make sure we are backward-compatible, so probably want to maintain some of the methods even though they are moved, but show a deprecation warning for a certain amount of time.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia eseguendo un audit dell’API attuale, in particolare dei metodi in widgets/button, e identifica le funzionalità che non appartengono a namespace specifici di button. Mappa i possibili namespace di destinazione e valuta come preservare la compatibilità all’indietro tramite deprecated methods. Il lavoro è completato quando l’API dispone di un piano di riorganizzazione documentato con un approccio alla deprecazione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
frontend
Tipo di issue
Refactoring
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.