zloirock/core-js

[types] documenting features as typescript

Open

#1 064 ouverte le 25 mars 2022

Voir sur GitHub
 (8 commentaires) (0 réactions) (0 assignés)JavaScript (1 609 forks)batch import
docshelp wanted

Métriques du dépôt

Stars
 (23 771 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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!

Guide contributeur

Direction de recherche
Identifiez tous les blocs de code marqués comme javascript dans la section fonctionnalités du README et convertissez les en déclarations de type TypeScript valides. Assurez vous que la coloration syntaxique fonctionne et que le code peut être copié et collé en toute sécurité par les utilisateurs TypeScript.
Stack technique
javascripttypescript
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
TypeScriptGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75