facebook/flow

Improce docs & examples for interfaces, modules, classes, etc.

Open

#3.682 geöffnet am 7. Apr. 2017

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (22.203 Stars) (1.885 Forks)batch import
Accepting PRshelp wanted

Beschreibung

hi, I find it very hard to move into imports, exports, declares, modules, successfully with flow, I have failed so far. And reading other issues has made it appear to me that other (even smart) people have been tripped up by all this random example: https://github.com/facebook/flow/issues/769. Thus I would like to suggest that somebody who really groks this stuff does some pair documenting with somebody who doesn't, to work up some succinct but fully fleshed out examples.

Contributor Guide

Tech Stack
javascript
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Basic knowledge of JavaScriptFamiliarity with Flow type system
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65
Research-Richtung
The issue requests improved documentation and examples for Flow's interfaces, modules, classes, and related concepts. The body references issue #769, which may contain additional context. Maintainers should identify specific gaps in the current documentation, possibly by reviewing existing docs and examples. Then create concise, step by step examples covering imports, exports, declares, and modules. The work should be coordinated with maintainers to ensure accuracy.