guardian/dotcom-rendering

Remove `index.d.ts`

Offen

#7.638 geöffnet am 26.04.2023

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (1 Reaktion) (1 zugewiesene Person)TypeScript (35 Forks)auto 404
Pick me upTeam Candidate: WebXgood first issue

Repository-Metriken

Stars
 (271 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Why?

Declaration files create ambient types, which appear in a global namespace across the project. We think it's preferable to avoid adding types to a global scope, and instead prefer to import them as needed.

How?

Migrate the types in the index.d.ts1 file into normal .ts files, and import them as needed:

Footnotes

  1. https://github.com/guardian/dotcom-rendering/blob/4ea272b55efa01ba88f0f5ff60f6bc9d14198147/dotcom-rendering/index.d.ts ↩

Contributor Guide

Research-Richtung
Identifiziere alle Typen in index.d.ts und verschiebe sie in separate .ts Dateien, importiere sie dann dort, wo sie benötigt werden.
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
TypeScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75