graphql / graphql/graphql.github.io

Schema Design: Be explicit with descriptions

Ouverte
#2,354 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
TypeScript
Étoiles
889
Forks
1.5k
Merge moyen
4 j 12 h
PR mergées (30 j)
21

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par localiser les définitions du schéma dans la base de code graphql.github.io et examinez la manière dont leurs descriptions sont actuellement rédigées. Le travail est considéré comme terminé lorsque les descriptions fournissent du contexte et des définitions claires, évitent les acronymes propres à l’équipe, documentent chaque valeur de l’enum, renvoient vers des sources faisant autorité lorsque cela est pertinent et incluent l’objectif, des indications vers des informations supplémentaires et des exemples concrets.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
graphql, typescript
Domaine
api, documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
48/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.