Enums are not documented
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 停滞
- 技術スタック
- typescript
調査の方向性
まず src/main.ts のインターフェースコメントを読み、現在の README と比較します。SyntaxKind と NodeType で許可される値を含め、src/main.ts のすべての項目をドキュメント化してください。README が完全なインターフェースを網羅し、読者が src/ を調べる必要がなくなれば完了です。
索引モデルが issue の本文から書いたものです。
説明
The only documentation for this library appears to be the README. However, this documentation is incomplete. The README documentation references several "enum-type" types, such as SyntaxKind (an enum{}) or NodeType (a union type supporting seven strings). Without knowing the allowed values of these enums, the library is not usable.
Clicking around in the github repo, I found src/main.ts, an extremely readable file with comments documenting the entire interface including the enums. I was able to use this to write my code. However a less experienced coder might not think to look for documentation in the src/ folder.
Expected behavior
All items from src/main.ts should be included in the README documentation, including the enums.
- 主要言語
- TypeScript
- スター
- 759
- フォーク
- 66
- 平均マージ
- 5日 10時間
- マージ済み PR（30日）
- 7
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
microsoft/node-jsonc-parser のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 72/100
microsoft/node-jsonc-parser#125 · コメント 1 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
microsoft/node-jsonc-parser#105 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
microsoft/node-jsonc-parser#103 · コメント 2 件 · リアクション 8 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 48/100
microsoft/node-jsonc-parser#97 · リアクション 2 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
microsoft/node-jsonc-parser#95 · リアクション 1 件 ·
microsoft/node-jsonc-parser の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
copse-dev/agent-pane#2953 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
bug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
calcite-components needs triage refactor
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
Esri/calcite-design-system#15203 ·