reactjs/react.dev

Add Flow types to website source

Open

#24 opened on Oct 6, 2017

View on GitHub
 (16 comments) (0 reactions) (0 assignees)JavaScript (7,898 forks)github user discovery
difficulty: mediumgood first issuein-progresstype: website

Repository metrics

Stars
 (11,763 stars)
PR merge metrics
 (Avg merge 37d 15h) (21 merged PRs in 30d)

Description

Replace PropTypes with Flow types for our components in www (and make sure yarn flow checks these types to protect against regressions).

I got the ball rolling with commit 1de4c66

This Twitter thread also has some interesting discussion for auto-generating Flow types for Gatsby's graphql queries.

Contributor guide

Research direction
Examine the initial commit 1de4c66 to understand the conversion pattern, then replace PropTypes with Flow types for all components in the www directory. Run yarn flow to ensure type checking passes.
Tech stack
javascript
Domain
frontend
Issue type
Refactor
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.
Half day
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.
Clear
Prerequisites
GitJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70