SolidOS / SolidOS/solid-ui

Clean up API

Offen
#120 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement
Vorherrschende Sprache
TypeScript
Sterne
153
Forks
46
Ø Merge
1 T. 8 Std.
Gemergte PRs (30 T.)
7

Beschreibung

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.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der Prüfung der aktuellen API, insbesondere der Methoden in widgets/button, und identifiziere Funktionen, die nicht in button-spezifische Namespaces gehören. Ordne mögliche Ziel-Namespaces zu und prüfe, wie die Abwärtskompatibilität durch deprecated methods erhalten werden könnte. Als erledigt gilt die Aufgabe, wenn die API über einen dokumentierten Reorganisationsplan mit einem Deprecation-Ansatz verfügt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
frontend
Issue-Typ
Refactoring
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.