Document changes to what assets are delivered in new npm packages

Aperta
#581 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
42/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

Aggiorna la readme.md principale e i file readme.md presenti in ogni cartella dei pacchetti. Inizia esaminando la struttura dei pacchetti e le descrizioni attuali degli asset, quindi documenta che i nuovi pacchetti npm forniscono asset woff e woff2 e possono includere solo asset con hinting quando i limiti di dimensione lo richiedono. Il lavoro è completato quando sia la documentazione principale sia quella dei pacchetti indicano queste regole di distribuzione.

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

Descrizione

I'm excited to see this project moving to being a monorepo and publishing individual packages per-family to npm, like @ibm/plex-sans 🎉

I support the decision to only provide woff and woff2 assets moving forward. I also think it makes sense to only provide the hinted assets in cases where providing hinted and unhinted would balloon the npm package size past the limit that npm supports. From our support ticket with them:

The maximum package size is 256MB for a package tarball and there is a file limit of 65,000 files. We are unable to extend the package size limits.

This should be documented though - ideally in both the root readme.md, but also on the readme.md in each package folder.

Lingua principale
CSS
Stelle
11.8k
Fork
626
Merge medio
1g 9h
PR unite (30g)
2

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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.

Altre issue di IBM/plex

Tutte le issue di IBM/plex

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.