webcomponents / webcomponents/webcomponents.org

[catalog-api] Consider new names for "Readable" and "Unreadable"

Aperta
#1,373 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
New Site
Lingua principale
TypeScript
Stelle
385
Fork
80
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Right now we have interfaces `ReadablePackageInfo`/`UnreadablePackageInfo`, and `ReadablePackageVersion`/`UnreadablePackageVersion` to represent the difference between documents that have successfully been imported and can be read vs documents that haven't because they errored, are invalid, etc.

The names might not be the best.

Some alternate possibilities:
- Saved / Unsaved
- Indexed / NonIndexed
- Imported / NonImported

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia individuando le interfacce TypeScript ReadablePackageInfo, UnreadablePackageInfo, ReadablePackageVersion e UnreadablePackageVersion in catalog-api. Traccia il modo in cui le interfacce distinguono i documenti importati correttamente da quelli con errori o non validi, quindi valuta se le alternative di denominazione proposte preservano tale significato. Il lavoro è considerato completato quando è stata concordata una direzione per la denominazione, non con una semplice modifica al codice.

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

Valutazione

Stack tecnologico
typescript
Ambito
api
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.