Document changes to what assets are delivered in new npm packages

Offen
  • Stimmt etwas nicht?
#581 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
42/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Veraltet
Bereich
documentation

Rechercherichtung

Aktualisiere die root readme.md und die readme.md-Dateien in jedem Paketordner. Überprüfe zunächst die Paketstruktur und die aktuellen Asset-Beschreibungen und dokumentiere dann, dass neue npm-Pakete woff- und woff2-Assets bereitstellen und bei erforderlichen Größenbeschränkungen möglicherweise nur Assets mit Hinting enthalten. Erledigt ist die Aufgabe, wenn sowohl die Root- als auch die Paketdokumentation diese Auslieferungsregeln festhalten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
CSS
Sterne
11.8k
Forks
626
Ø Merge
1 T. 9 Std.
Gemergte PRs (30 T.)
2

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus IBM/plex

Alle Issues in IBM/plex

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

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