Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add definitions to the style guide #1137

Merged
merged 4 commits into from
Feb 26, 2025
+9 −0
Merged

Add definitions to the style guide #1137

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e1056fc
Add tone of voice and definitions to the style guide
martinbonnin Feb 25, 2025
1e198e6
Update STYLE_GUIDE.md
martinbonnin Feb 25, 2025
6578a30
remove tone of voice
martinbonnin Feb 25, 2025
540392c
format
martinbonnin Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions STYLE_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,3 +82,24 @@ MyAlgorithm(argOne, argTwo):
- Let {something} be {true}.
- Return {something}.
```

## Definitions

For important terms, use [Spec Markdown definition paragraphs](https://spec-md.com/#sec-Definition-Paragraph).

Definition paragraphs start with `::` and addsthe matching italicized term to the
[specification index](https://spec.graphql.org/draft/#index), making it easy to
reference them.

## Tone of voice

The GraphQL specification is a reference document and should use neutral and
descriptive tone of voice.

Favor the present tense. The present tense is usually clearer and shorter:

✅ Present: The client then sends a request to the server.
❌ Future: The client will then send a request to the server.

Avoid repetition. Repetition adds more cognitive load and possibilities for different
parts of the specification to diverge in their meaning.
Loading