diff --git a/README.md b/README.md index a27fc7a..fd95fc3 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,13 @@ Thanks for contributing to GraphQL Scalars. The goal of the GraphQL Scalars project is to provide a directory of GraphQL -Custom Scalar specifications, contributed by the community. Contributed +custom scalar specifications, contributed by the community. Contributed specifications are hosted on a GraphQL Foundation owned domain [scalars.graphql.org](https://scalars.graphql.org), which can be referenced with the built-in `@specifiedBy` [GraphQL directive](https://spec.graphql.org/draft/#sec--specifiedBy). -GraphQL Custom Scalar specifications are language agnostic and thus can be used +GraphQL custom scalar specifications are language-agnostic and thus can be used to document and standardize behavior across different languages. Please ensure that you read the @@ -20,10 +20,10 @@ this project. 1. Copy the `template-string.md` [template](https://github.com/graphql/graphql-scalars/blob/main/scalars/template-string.md) - for Custom Scalars based on the built-in String Scalar, or otherwise use the + for custom scalars based on the built-in String scalar, or otherwise use the `template.md` [template](https://github.com/graphql/graphql-scalars/blob/main/scalars/template.md) - for all other Custom Scalars. Templates are located in the + for all other custom scalars. Templates are located in the [graphql-scalars GitHub repository](https://github.com/graphql/graphql-scalars/tree/main/scalars). 2. Modify your selected template, and save it in the correct place @@ -42,7 +42,7 @@ this project. 4. Run `npm test` to ensure proper formatting before submitting a pull request. 5. [Open a new pull request](https://github.com/graphql/graphql-scalars/pulls) - for each Custom Scalar specification you would like to add. + for each custom scalar specification you would like to add. ### Review process @@ -58,7 +58,7 @@ Specification semantics must not change, as specifications are publicly available reference documents. We will permit small edits which do not change specification semantics, such as typo fixes. -A new version of a Custom Scalar specification should have a new scalar name, +A new version of a custom scalar specification should have a new scalar name, either with a number appended such as `2`, or a different name such as `OffsetDateTime` to differentiate from `DateTime`. diff --git a/scalars/template-string.md b/scalars/template-string.md index 15eb915..4e56af5 100644 --- a/scalars/template-string.md +++ b/scalars/template-string.md @@ -7,7 +7,7 @@ "Date - \" This template is meant to be copied and modified. This template is meant for -Scalars which are based on the built-in String Scalar +scalars which are based on the built-in String scalar **License and Copyright** @@ -16,22 +16,22 @@ Copyright © GraphQL contributors. This specification is licensed under # Overview -Provide an overview of what this Scalar does and provide any background +Provide an overview of what this scalar does and provide any background information. # Name -Provide a recommended Scalar name and list alternatives, if available. +Provide a recommended scalar name and list alternatives, if available. # Result spec -Define which Strings can be returned. +Define which strings can be returned. -Provide positive and negative examples of String return values. +Provide positive and negative examples of string return values. # Input spec -Define which String values are accepted as input as GraphQL Literal and as JSON +Define which string values are accepted as input as GraphQL Literal and as JSON raw input. Provide positive and negative examples of literal and JSON raw input values. diff --git a/scalars/template.md b/scalars/template.md index 8aa60d1..dcc27f7 100644 --- a/scalars/template.md +++ b/scalars/template.md @@ -7,7 +7,7 @@ "Date - \" This template is meant to be copied and modified. This template is meant for -Scalars which are _not_ based on the built-in String Scalar +scalars which are _not_ based on the built-in String scalar **License and Copyright** @@ -16,12 +16,12 @@ Copyright © GraphQL contributors. This specification is licensed under # Overview -Provide an overview of what this Scalar does and provide any background +Provide an overview of what this scalar does and provide any background information. # Name -Provide a recommended Scalar name and list alternatives, if available. +Provide a recommended scalar name and list alternatives, if available. # Result JSON spec