zloirock/core-js

[types] documenting features as typescript

Open

#1,064 opened on Mar 25, 2022

View on GitHub
 (8 comments) (0 reactions) (0 assignees)JavaScript (1,609 forks)batch import
docshelp wanted

Repository metrics

Stars
 (23,771 stars)
PR merge metrics
 (No merged PRs in 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!

Contributor guide

Research direction
Identify all code blocks tagged as javascript in the README features section and convert them to valid TypeScript type declarations. Ensure syntax highlighting works and the code is copy paste safe for TypeScript users.
Tech stack
javascripttypescript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
TypeScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75