Document changes to what assets are delivered in new npm packages

Aberta
#581 1 comentário 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
42/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Estagnada
Domínio
documentation

Direção de pesquisa

Atualize a readme.md raiz e os arquivos readme.md em cada pasta de pacote. Comece revisando o layout dos pacotes e as descrições atuais dos assets; em seguida, documente que os novos pacotes npm fornecem assets woff e woff2 e podem incluir apenas assets com hinting quando os limites de tamanho exigirem isso. A tarefa estará concluída quando tanto a documentação raiz quanto a dos pacotes declararem essas regras de distribuição.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
CSS
Estrelas
11.8k
Forks
626
Merge médio
1d 9h
PRs com merge (30d)
2

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de IBM/plex

Todas as issues de IBM/plex

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.