Document the public API of @usine/engine in TSDoc
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 55/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- typescript
調査の方向性
Read AGENTS.md and CONTEXT.md, then inspect the public exports and subpaths in packages/engine and the generated API reference at apps/docs/src/content/docs/reference/api/engine/. Document exports first, then members and service operations using domain vocabulary; consult linked ADRs where they explain a rule. Run pnpm build and pnpm turbo run build --filter=@usine/docs; done means both builds pass and the regenerated reference has zero undocumented items from the stated counts.
索引モデルが issue の本文から書いたものです。
説明
Part of #294. In packages/engine, 13 of 70 top-level exports and 103 of 151 own fields, methods and service operations of the public subpaths have no TSDoc (counted from the generated API reference at https://docs.usine.dev/reference/api/engine/ on 2026-10-17).
Document each exported element in domain terms, as AGENTS.md asks: what it represents, what its arguments mean, and what callers can expect beyond the TypeScript signature. Use the vocabulary of CONTEXT.md. Link an ADR when it explains a rule. Plain sentences, no literary verbs for objects, no em dashes.
Scope: TSDoc only. No behaviour change, no renames. Do the exports first, then members and service operations. If an export turns out to be an implementation detail that should not be public, say so in the PR instead of documenting it.
Done when pnpm build passes and the counts above are zero in the regenerated reference (pnpm turbo run build --filter=@usine/docs, then open apps/docs/src/content/docs/reference/api/engine/).
Decisions (2026-10-28)
- Recount the gaps from a fresh
pnpm turbo run build --filter=@usine/docs; the counts in #294 are from 2026-10-17 and stale. - Follow the merged siblings #320 (expression), #321 (durable), and #323 (executor): Google API-reference comments (AGENTS.md), ADRs cited as plain "(ADR NNNN)" text rather than relative links, and one changeset for the package.
- Comments only; no behavior change.
- 主要言語
- TypeScript
- スター
- 1
- フォーク
- 0
- 平均マージ
- 4時間 39分
- マージ済み PR（30日）
- 243
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
basaltbytes/usine のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
basaltbytes/usine#725 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 68/100
basaltbytes/usine#742 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 38/100
basaltbytes/usine#724 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
basaltbytes/usine#723 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 58/100
basaltbytes/usine#722 ·
メンテナーはふだん 1 日以内に返信
basaltbytes/usine の issue をすべて見る
似ている issue
-
bug
難易度 1/5 1時間未満 初心者へのやさしさ 86/100
awslabs/visual-asset-management-system#937 ·
メンテナーはふだん 1 日以内に返信
-
t0ggles
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
nolimits4web/swiper#8255 · コメント 1 件 ·
メンテナーはふだん 15 日以内に返信
-
render: --variables-file (and --variables <path>) fails with "io.readFile is not a function" since 0.8.212対応中かも @miguel-heygen が今日担当しました。 オープンbug triage/needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
heygen-com/hyperframes#6830 ·
メンテナーはふだん 1 日以内に返信
-
bug launch local use
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信
-
account: profile bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 5 日以内に返信