cube-js/cube

Facilitate comments in GraphQL schema generation flow

Open

#6,246 opened on 2023年3月6日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)Rust (1,965 forks)batch import
api:graphqlhelp wanted

Repository metrics

Stars
 (19,563 stars)
PR merge metrics
 (平均マージ 5d 16h) (30d で 138 merged PRs)

説明

Is your feature request related to a problem? Please describe. The GraphQL schema that is generated has no comments/documentation. It does not suit inclusion into a well documented federated graph.

Describe the solution you'd like A way to annotate dimensions such that the generated GraphQL types have some degree of documentation.

Describe alternatives you've considered Manual documentation post-generation. It does not suit our needs as we scale up

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

調査方針
CubeがGraphQLスキーマを生成する方法を調査し、ディメンションとメジャーにコメントを追加する場所を特定します。スキーマ生成コードを調べて、CubeデータモデルからGraphQLスキーマ定義にドキュメンテーション注釈を渡す方法を見つけてください。
技術スタック
graphql
領域
backendapi
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
おおむね明確
前提条件
GraphQL
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60