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.
Improce docs & examples for interfaces, modules, classes, etc. · facebook/flow#3682 | Good First Issue