graphql / graphql/graphql.github.io
Schema Design: Be explicit with descriptions
Aperta
- Lingua principale
- TypeScript
- Stelle
- 889
- Fork
- 1.5k
- Merge medio
- 4g 12h
- PR unite (30g)
- 21
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Valutazione
Questa issue non è ancora stata valutata.