Skip to content

Commit 05174be

Browse files
Highlight that the name is a recommendation (#35)
* Highlight that the name is a recommentation * Update README.md Co-authored-by: Glen <[email protected]> * Update README.md Co-authored-by: Glen <[email protected]> * Update README.md Co-authored-by: Glen <[email protected]> --------- Co-authored-by: Glen <[email protected]>
1 parent 6402d3e commit 05174be

File tree

3 files changed

+10
-5
lines changed

3 files changed

+10
-5
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,14 @@ Specification semantics must not change, as specifications are publicly
5858
available reference documents. We will permit small edits which do not change
5959
specification semantics, such as typo fixes.
6060

61-
A new version of a Custom Scalar specification should have a new scalar name,
62-
either with a number appended such as `<scalar-name>2`, or a different name such
63-
as `OffsetDateTime` to differentiate from `DateTime`.
61+
A new version of a Custom Scalar specification must use a new URL but may still
62+
recommend using the old name.
63+
64+
For example, `scalars/contributed/my_username/date-time-v2.md` may recommend
65+
using `DateTime` for the scalar name.
66+
67+
You may use a `-v<version>` suffix to indicate new versions, but this is not a
68+
requirement.
6469

6570
## Licensing
6671

scalars/template-string.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Copyright © GraphQL contributors. This specification is licensed under
1919
Provide an overview of what this Scalar does and provide any background
2020
information.
2121

22-
# Name
22+
# Recommended name
2323

2424
Provide a recommended Scalar name and list alternatives, if available.
2525

scalars/template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Copyright © GraphQL contributors. This specification is licensed under
1919
Provide an overview of what this Scalar does and provide any background
2020
information.
2121

22-
# Name
22+
# Recommended name
2323

2424
Provide a recommended Scalar name and list alternatives, if available.
2525

0 commit comments

Comments
 (0)