graphql / graphql/graphql.github.io

Schema Design: Be explicit with descriptions

オープン
#2,354 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
TypeScript
スター
889
フォーク
1.5k
平均マージ
4日 12時間
マージ済み PR(30日)
21

説明

Provide comprehensive context in descriptions, including clear definitions. Avoid team-specific acronyms, describe all enum values, and link to authoritative sources where relevant.

Rationale: Future developers should be able to understand schema elements using only the provided documentation. Include what a concept is, why it matters, where to find additional information, and concrete examples for enum options.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず graphql.github.io コードベース内のスキーマ定義を見つけ、現在その説明がどのように記述されているかを確認します。説明にコンテキストと明確な定義があり、チーム固有の頭字語を避け、すべての enum 値を文書化し、関連する場合は信頼できる情報源にリンクし、目的、追加情報への参照、具体例を含んでいれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
graphql, typescript
領域
api, documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
48/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。