Document changes to what assets are delivered in new npm packages

Ouverte
#581 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
42/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
À l'abandon
Domaine
documentation

Piste de recherche

Mettez à jour la readme.md racine et les fichiers readme.md de chaque dossier de package. Commencez par examiner la structure des packages et les descriptions actuelles des assets, puis documentez que les nouveaux packages npm fournissent des assets woff et woff2 et peuvent ne contenir que des assets avec hinting lorsque les limites de taille l’exigent. C’est terminé lorsque la documentation racine et celle des packages indiquent toutes deux ces règles de distribution.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
CSS
Étoiles
11.8k
Forks
626
Merge moyen
1 j 9 h
PR mergées (30 j)
2

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de IBM/plex

Toutes les issues de IBM/plex

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.