graphql / graphql/graphql.github.io

Schema Design: Be explicit with descriptions

Offen
#2,354 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
TypeScript
Sterne
889
Forks
1.5k
Ø Merge
4 T. 12 Std.
Gemergte PRs (30 T.)
21

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Start by locating the schema definitions in the graphql.github.io codebase and review how their descriptions are currently written. Done means descriptions provide context and clear definitions, avoid team-specific acronyms, document every enum value, link authoritative sources where relevant, and include purpose, additional-information pointers, and concrete examples.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
graphql, typescript
Bereich
api, documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.