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
specifications are hosted on a GraphQL Foundation owned domain
scalars.graphql.org, which can be referenced with
the built-in @specifiedBy
GraphQL directive.
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
Code of Conduct before contributing to
this project.
Copy the template-string.md
template
for custom scalars based on the built-in String scalar, or otherwise use the
template.md
template
for all other custom scalars. Templates are located in the
graphql-scalars GitHub repository.
Modify your selected template, and save it in the correct place
scalars/contributed/<github-user-or-organization-name>/<scalar-name>.md in
the
graphql-scalars GitHub repository.
The directory location is important, as this will form part of the reference
URL for your specification. In case you are using an organization name, we
will manually verify that you are allowed to make the contribution in the
name of the organization.
Install dependencies with npm install and the run npm run build to
locally build the resulting public specification files. Navigate to the
/public folder to view the built files.
Run npm test to ensure proper formatting before submitting a pull request.
Open a new pull request
for each custom scalar specification you would like to add.
Because this repository is separate from the main GraphQL spec, and because
several specifications may exist concurrently under different names/authors, the
review process for new specifications under contributed/ is very light.
Anyone may review pull requests. Feedback may or may not be incorporated at the
discretion of the original author. When they consider the pull request has
reached a satisfactory state, but not before a 2 week review window, the author
may ask a TSC member to merge the pull request. The TSC will then merge the pull
request without further discussion.
This document, and all content excluding contributed/ may be changed with the
TSC’s
approval. This is usually longer than reviewing new specifications.
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 must use a new URL but may still
recommend using the old name.
For example, scalars/contributed/my_username/date-time-v2.md may recommend
using DateTime for the scalar name.
You may use a -v<version> suffix to indicate new versions, but this is not a
requirement.
Specifications contributed to the GraphQL Scalars repository are part of the
GraphQL Specification Project and are made available by the
Joint Development Foundation. The current
GraphQL Working Group charter, which
includes the IP policy governing all working group deliverables (including
specifications, source code, and datasets) may be found in the
technical charter.
By contributing to this repository, you agree to license your work according to
the licenses governing GraphQL Specification Project deliverables, which are:
| Deliverable | License |
|---|---|
| Specifications | Open Web Foundation Agreement 1.0 (Patent and Copyright Grants) |
| Source code | MIT License |
| Data sets | CC0 1.0 |
This repository is managed by EasyCLA. Project participants must sign the free
GraphQL Specification Membership agreement
before making a contribution. You only need to do this one time, and it can be
signed by
individual contributors or
their employers.
To initiate the signature process please open a PR against this repo. The
EasyCLA bot will block the merge if we still need a membership agreement from
you.
You can find
detailed information here.
If you have issues, please email
operations@graphql.org.
Copyright © GraphQL contributors
THESE MATERIALS ARE PROVIDED “AS IS”. The parties expressly disclaim any
warranties (express, implied, or otherwise), including implied warranties of
merchantability, non-infringement, fitness for a particular purpose, or title,
related to the materials. The entire risk as to implementing or otherwise using
the materials is assumed by the implementer and user. IN NO EVENT WILL THE
PARTIES BE LIABLE TO ANY OTHER PARTY FOR LOST PROFITS OR ANY FORM OF INDIRECT,
SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER FROM ANY CAUSES
OF ACTION OF ANY KIND WITH RESPECT TO THIS DELIVERABLE OR ITS GOVERNING
AGREEMENT, WHETHER BASED ON BREACH OF CONTRACT, TORT (INCLUDING NEGLIGENCE), OR
OTHERWISE, AND WHETHER OR NOT THE OTHER MEMBER HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
This project abides by the GraphQL Foundation’s
Code of Conduct.