reactjs / reactjs/react-docgen
Documentation for JSDoc support
オープン
まだ誰も着手していません。
- 主要言語
- TypeScript
- スター
- 3.8k
- フォーク
- 316
- 平均マージ
- 5時間 7分
- マージ済み PR（30日）
- 4
説明
In the README there is no mention of JSDoc and what subset of JSDoc syntax react-docgen supports.
Would help to have some documentation explaining the usage with JSDoc.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
README とリポジトリの JSDoc サポートのエントリーポイントから始めてください。JSDoc を react-docgen とともに使用する方法を文書化し、サポートされている JSDoc 構文のサブセットを明確に説明してください。そうすれば、読者は issue の議論に頼らずにこの機能を理解できます。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- react, typescript
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 38/100