Document changes to what assets are delivered in new npm packages

Abierto
#581 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
42/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado

Línea de trabajo

Actualiza la readme.md raíz y los archivos readme.md de cada carpeta de paquete. Empieza revisando la estructura de paquetes y las descripciones actuales de los assets; después documenta que los nuevos paquetes npm proporcionan assets woff y woff2 y pueden incluir únicamente assets con hinting cuando los límites de tamaño lo requieran. Se considera terminado cuando tanto la documentación raíz como la de los paquetes indican estas reglas de distribución.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
CSS
Estrellas
11.8k
Forks
626
Merge medio
1 d 9 h
PR fusionados (30 d)
2

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de IBM/plex

Todos los issues de IBM/plex

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.