facebook/flow

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

Open

#3,682 建立於 2017年4月7日

在 GitHub 查看
 (3 留言) (0 反應) (0 負責人)Rust (22,203 star) (1,885 fork)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
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.