facebook/flow

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

Open

#3,682 opened on 2017年4月7日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)Rust (22,203 stars) (1,885 forks)batch import
Accepting PRshelp wanted

説明

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.

コントリビューターガイド

技術スタック
javascript
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
Basic knowledge of JavaScriptFamiliarity with Flow type system
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
65
調査方針
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.