CedarCopilot/cedar-OS

fix: make type discoverability better

オープン

#131 opened on 2025/08/28

GitHub で見るコントリビューターガイド
 (1 件のコメント) (0 件のリアクション) (0 人の担当者)TypeScript (18 件のフォーク)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (169 個のスター)
PR merge metrics
 (30d に merged PR はありません)

説明

For types exposed to the user (mainly in AgentConnectionTypes.ts and AgentInputContextTypes.ts, we need to make the discoverability of the types better, especially if they take in generic parameters.

Probably would use Typedocs for Typescript types, and an equivalent for Zod types.

コントリビューターガイド

調査方針
TypeScript型のTypedoc設定と、AgentConnectionTypes.tsおよびAgentInputContextTypes.ts内のZodスキーマに対応する設定を調査します。既存のドキュメントパターンを確認し、JSDocコメントやZod.describe()呼び出しをどこに配置するかを決定します。
技術スタック
typescript
領域
frontenddeveloper experience
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
TypeScriptZod
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
65