UTDNebula/utd-trends

[Internal] Modular API's (in components)

Offen

#177 geöffnet am 31.08.2024

Auf GitHub ansehenContributor Guide
 (7 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (35 Forks)auto 404
Good First IssueMultiple EngineersStatus: On HoldType: DocumentationType: Internal

Repository-Metriken

Stars
 (28 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 16T 20h) (1 gemergte PR in 30 T)

Beschreibung

Overview of Proposed Changes

What: Ensure all API calls are occurring in their respective components Why: Modularity, cleaner code

Details

  • Write/update documentation about how/which APIs are called in Trends
  • Identify API calls outside of components
  • Move outstanding stray API calls to inside components
  • Write documentation on how and where Trends is using the APIs

Contributor Guide

Research-Richtung
Untersuche die Codebasis, um API Aufrufe zu identifizieren, die derzeit außerhalb von Komponenten (insbesondere in Trends) erfolgen, und verschiebe sie in die entsprechenden Komponenten. Aktualisiere die Dokumentation entsprechend.
Tech Stack
typescript
Domain
frontend
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitTypeScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60