TSDoc coverage gaps in the published packages
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 48/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- typescript
調査の方向性
Read AGENTS.md and inspect the generated API reference at apps/docs/reference/api/ to identify undocumented public exports. Start with the core envelope classes, agents, and engine, then document their exports and service operations in domain terms. Also inspect packages/core/src/worker.ts:61 and fix the broken ADR 0027 link; done when the listed TSDoc gaps are covered and the package link works.
索引モデルが issue の本文から書いたものです。
説明
The generated API reference (/reference/api/ in apps/docs) shows how much of the public API has no TSDoc. AGENTS.md asks for every exported element to be documented in domain terms.
| Package | Undocumented exports | Undocumented members |
|---|---|---|
| core | 27/229 (the attempt/channel envelope classes) | 153/166 |
| agents | 13/67 | 59/81 |
| engine | 13/70 | 103/151 |
| orchestrator | 10/102 | 186/205 |
| github | 9/83 | 64/77 |
| config | 7/73 | 86/99 |
| gateway | 1/75 | 77/88 |
| durable | 0/38 | 21/53 |
| executor | 0/33 | 30/67 |
| expression | 0/19 | 14/20 |
Members are own fields, methods, and service operations. Exports count top-level declarations, so a type and a value with the same name count twice.
Also: packages/core/src/worker.ts:61 links ADR 0027 with a relative path (../../../docs/adr/...), which is broken in the npm tarball; the docs site rewrites it to GitHub.
Start with the exports (core envelope classes, agents, engine), then service operations.
- 主要言語
- TypeScript
- スター
- 1
- フォーク
- 0
- 平均マージ
- 4時間 26分
- マージ済み PR（30日）
- 280
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
basaltbytes/usine のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
basaltbytes/usine#801 ·
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
basaltbytes/usine#800 ·
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 10/100
basaltbytes/usine#799 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
basaltbytes/usine#798 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
basaltbytes/usine#792 ·
メンテナーはふだん 1 日以内に返信
basaltbytes/usine の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
Northeastern-Electric-Racing/FinishLine#4660 ·
メンテナーはふだん 2 日以内に返信
-
BeOS .json missingオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
mihaip/infinite-mac#475 ·
-
Let TypeScript accept an initial object in ReactiveDict対応中かも @yograj-vijay-yadav が今日担当しました。 オープンbug good first issue help wanted workshop
難易度 2/5 1〜3時間 初心者へのやさしさ 92/100
meteor/meteor#14919 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
marmelab/atomic-crm#401 ·
メンテナーはふだん 1 日以内に返信
-
account: profile
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
メンテナーはふだん 5 日以内に返信