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 tone of voice #1138

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add tone of voice #1138

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ac3da61
add tone of voice
martinbonnin Feb 25, 2025
5294d1d
format
martinbonnin Feb 25, 2025
0cde790
fix formating
martinbonnin Feb 25, 2025
3a1cc03
formatting
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
18 changes: 18 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,21 @@ MyAlgorithm(argOne, argTwo):
- Let {something} be {true}.
- Return {something}.
```

## 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.