Skip to content

Commit 70ce54c

Browse files
authored
Merge branch 'main' into add-tone-of-voice
2 parents 0caea6d + 3c02659 commit 70ce54c

File tree

3 files changed

+15
-5
lines changed

3 files changed

+15
-5
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ contributions.
66

77
Contributions that do not change the interpretation of the spec but instead
88
improve legibility, fix editorial errors, clear up ambiguity and improve
9-
examples are encouraged and are often merged by a spec editor with little
10-
process.
9+
examples are encouraged. These "editorial changes" will normally be given the
10+
["✏ Editorial" label](https://github.com/graphql/graphql-spec/issues?q=sort%3Aupdated-desc+is%3Aopen+label%3A%22%E2%9C%8F%EF%B8%8F+Editorial%22)
11+
and are often merged by a spec editor with little process.
1112

1213
However, contributions that _do_ meaningfully change the interpretation of the
1314
spec must follow an RFC (Request For Comments) process led by a _champion_

STYLE_GUIDE.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,15 @@ MyAlgorithm(argOne, argTwo):
8383
- Return {something}.
8484
```
8585

86+
## Definitions
87+
88+
For important terms, use
89+
[Spec Markdown definition paragraphs](https://spec-md.com/#sec-Definition-Paragraph).
90+
91+
Definition paragraphs start with `::` and add the matching italicized term to
92+
the [specification index](https://spec.graphql.org/draft/#index), making it easy
93+
to reference them.
94+
8695
## Tone of voice
8796

8897
The GraphQL specification is a reference document and should use neutral and
@@ -95,4 +104,3 @@ The present tense is usually clearer and shorter:
95104
✅ Present: The client then sends a request to the server.
96105

97106
❌ Future: The client will then send a request to the server.
98-

spec/Section 5 -- Validation.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -420,7 +420,7 @@ FieldsInSetCanMerge(set):
420420

421421
- Let {fieldsForName} be the set of selections with a given response name in
422422
{set} including visiting fragments and inline fragments.
423-
- Given each pair of members {fieldA} and {fieldB} in {fieldsForName}:
423+
- Given each pair of distinct members {fieldA} and {fieldB} in {fieldsForName}:
424424
- {SameResponseShape(fieldA, fieldB)} must be true.
425425
- If the parent types of {fieldA} and {fieldB} are equal or if either is not
426426
an Object Type:
@@ -452,7 +452,8 @@ SameResponseShape(fieldA, fieldB):
452452
selection set of {fieldB}.
453453
- Let {fieldsForName} be the set of selections with a given response name in
454454
{mergedSet} including visiting fragments and inline fragments.
455-
- Given each pair of members {subfieldA} and {subfieldB} in {fieldsForName}:
455+
- Given each pair of distinct members {subfieldA} and {subfieldB} in
456+
{fieldsForName}:
456457
- If {SameResponseShape(subfieldA, subfieldB)} is {false}, return {false}.
457458
- Return {true}.
458459

0 commit comments

Comments
 (0)