reactjs / reactjs/react.dev

TestRenderer and ShallowRenderer docs are extremely limited.

未关闭
#1,572 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
JavaScript
星标
11.8k
派生
7.9k
平均合并
1 天 11 小时
30 天内合并 PR
11

描述

None of the api methods are thoroughly documented.
None of the api methods have example code provided.
None of the api methods have typing information for arguments and/or return values.

In order to use either of these libraries you have to do a ton of examining debugger results, digging through source code, and/or digging through Stackoverlow.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先找到 TestRenderer 和 ShallowRenderer 的文档及其公共 API 入口点。检查每个 API 方法,以确定缺少的描述、示例以及参数或返回值的类型信息。当两个库都有包含示例和类型细节的完整方法文档时,即视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript, react
领域
documentation
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。