Adding description to types
オープン
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 32/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- react, storybook, typescript
- 領域
- documentation, tooling
調査の方向性
まず、issue にある ActionIconProps の例をドキュメントジェネレーターまたは Storybook のセットアップで再現します。継承された React 型と /** My custom property */ の説明がどのように処理されるかを追跡します。完了の条件は、生成されたドキュメントでこれらの継承プロパティおよびカスタムプロパティの説明が保持されることです。
索引モデルが issue の本文から書いたものです。
説明
Can we add types description for React types, that can be supported for docs generators?
For example we use next inheritance:
import React, { ButtonHTMLAttributes, FC } from 'react'
export interface ActionIconProps
extends Pick<
ButtonHTMLAttributes<HTMLButtonElement>,
| 'title'
| 'tabIndex'
| 'className'
| 'style'
| 'aria-label'
| 'aria-haspopup'
| 'aria-expanded'
| 'onClick'
| 'onKeyDown'
| 'onMouseDown'
| 'onFocus'
| 'onBlur'
| 'disabled'
> {
/** My custom property */
myProp: string
}
and in doc system like Storybook it generated without description.
- 主要言語
- JavaScript
- スター
- 11.8k
- フォーク
- 7.9k
- 平均マージ
- 16時間 6分
- マージ済み PR（30日）
- 7
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
reactjs/react.dev のほかの issue
-
type: documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
-
bug: unconfirmed
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
-
type: typos
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
-
bug: unconfirmed
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100