graphql / graphql/graphql.github.io
Schema Design: Be explicit with descriptions
Open
- Dominant language
- TypeScript
- Stars
- 889
- Forks
- 1.5k
- Avg merge
- 4d 12h
- Merged PRs (30d)
- 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.
Contributor guide
Assessment
This issue has not been assessed yet.