zloirock/core-js

[types] documenting features as typescript

Open

#1.064 aberto em 25 de mar. de 2022

Ver no GitHub
 (8 comments) (0 reactions) (0 assignees)JavaScript (1.609 forks)batch import
docshelp wanted

Métricas do repositório

Stars
 (23.771 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Hi!

Context: in the README's features, there are block codes used to shown what's included in a feature (ex: https://github.com/zloirock/core-js/blob/v3.21.1/README.md#new-collections-methods). These blocks look a lot like typescript type declarations, but aren't.

First: shouldn't these blocks be tagged as typescript instead of javascript (sed /```js/```ts/g), so we can have proper syntax coloration?

Second: as a stepping point to #568, we could make these blocks correct typescript, so TS users can copy/paste them safely in their codebase when importing the polyfills (especially proposals).

If that's interesting, I could probably start a PR on that!

Guia do colaborador

Direção de pesquisa
Identifique todos os blocos de código marcados como javascript na seção de recursos do README e converta os em declarações de tipo TypeScript válidas. Certifique se de que o destaque de sintaxe funcione e que o código seja seguro para copiar e colar para usuários TypeScript.
Pilha de tecnologia
javascripttypescript
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
TypeScriptGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75