reactjs / reactjs/react-docgen
Extract comments from `defaultProps`
オープン
まだ誰も着手していません。
- 主要言語
- TypeScript
- スター
- 3.8k
- フォーク
- 316
- 平均マージ
- 5時間 7分
- マージ済み PR（30日）
- 4
説明
In our component library, a lot of comments are historically made on defaultProps not on propTypes. It would be nice if react-docgen could catch them as well
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
この issue にはファイル、テスト、エントリーポイントの指定がありません。まず、react-docgen が propTypes からコメントを抽出する方法と defaultProps の扱いを確認し、次に既存の抽出テストを実行してください。defaultProps に記述されたコメントが生成されたコンポーネントドキュメントに含まれれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- react, typescript
- 領域
- documentation
- issue の種類
- 機能追加
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 30/100