zloirock/core-js

[types] documenting features as typescript

Open

#1064 aperta il 25 mar 2022

Vedi su GitHub
 (8 commenti) (0 reazioni) (0 assegnatari)JavaScript (1609 fork)batch import
docshelp wanted

Metriche repository

Star
 (23.771 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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!

Guida contributor

Direzione di ricerca
Identifica tutti i blocchi di codice contrassegnati come javascript nella sezione delle caratteristiche del README e convertili in dichiarazioni di tipo TypeScript valide. Assicurati che l'evidenziazione della sintassi funzioni e che il codice sia sicuro da copiare e incollare per gli utenti TypeScript.
Tech stack
javascripttypescript
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
TypeScriptGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75