docs: add naming and design guide#2279
Merged
Merged
Conversation
|
@sarahxsanders is attempting to deploy a commit to the The GraphQL Foundation Team on Vercel. A member of the Team first needs to authorize it. |
martinbonnin
reviewed
Mar 7, 2026
martinbonnin
left a comment
martinbonnin
left a comment
Contributor
There was a problem hiding this comment.
Lots of very important things in that page!
I'd suggest breaking it down in different pages so those important topics get each their own entry points:
- naming, descriptions & linting
- nullability
- error handling
- scalars
- pagination
- anti-patterns
- Remove the nullable-by-default recommendation per review (martinbonnin), keeping the neutral nullability mechanics (bubbling, lists, inputs) - Extract the error-handling section into its own learn/error-handling page and link to it from the naming guide (per martinbonnin + Urigo) - Add a directives row to the naming conventions table - Recommend type descriptions alongside field descriptions - Link scalars.graphql.org for community custom scalar specs Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
martinbonnin
approved these changes
Jul 17, 2026
martinbonnin
enabled auto-merge (squash)
July 17, 2026 16:25
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
adds a new guide for the "schema governance" series on graphql.org/learn Includes new guide: Establish naming conventions and design standards:
Note: this needs heavy technical review - the content is based on heavy research i did, but since there's no strict naming conventions/guidance defined in the schema we will want to proceed with confidence that everything here is guidance we want to put out there!