From 8c9c7d6ef56c7158cf7f4ec4d4695bf5f0b540a7 Mon Sep 17 00:00:00 2001 From: Ivan Goncharov Date: Thu, 18 Mar 2021 14:58:18 +0200 Subject: [PATCH] docs: fix and update links to HTTPS also general cleanup (#317) --- .github/CONTRIBUTING.md | 23 +++++++++++++++++++++++ CHANGELOG.md | 4 ---- CONTRIBUTING.md | 34 ---------------------------------- README.md | 24 ++++++++++-------------- package.json | 2 +- 5 files changed, 34 insertions(+), 53 deletions(-) create mode 100644 .github/CONTRIBUTING.md delete mode 100644 CHANGELOG.md delete mode 100644 CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..32e3ec9 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# Contributing + +After cloning this repo, ensure dependencies are installed by running: + +```sh +npm install +``` + +GraphQL Relay is written in ES6 using [Babel](https://babeljs.io/), widely +consumable JavaScript can be produced by running: + +```sh +npm run build +``` + +Once `npm run build` has run, you may `import` or `require()` directly from +node. + +The full test suite can be evaluated by running: + +```sh +npm test +``` diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 8dfff36..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,4 +0,0 @@ -# graphql-relay changes - -Please see [the Releases -page](https://github.com/graphql/graphql-relay-js/releases) on GitHub. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 271f215..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,34 +0,0 @@ -# Contributing - -After cloning this repo, ensure dependencies are installed by running: - -```sh -npm install -``` - -GraphQL Relay is written in ES6 using [Babel](http://babeljs.io/), widely -consumable JavaScript can be produced by running: - -```sh -npm run build -``` - -Once `npm run build` has run, you may `import` or `require()` directly from -node. - -The full test suite can be evaluated by running: - -```sh -npm test -``` - -While actively developing, we recommend running - -```sh -npm run watch -``` - -in a terminal. This will watch the file system run lint, tests, and type -checking automatically whenever you save a js file. - -To lint the JS files and type interface checks run `npm run lint`. diff --git a/README.md b/README.md index ebd7680..ecabab5 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,11 @@ This is a library to allow the easy creation of Relay-compliant servers using th A basic understanding of GraphQL and of the GraphQL.js implementation is needed to provide context for this library. -An overview of GraphQL in general is available in the [README](https://github.com/facebook/graphql/blob/master/README.md) for the [Specification for GraphQL](https://github.com/facebook/graphql). +An overview of GraphQL in general is available in the [README](https://github.com/graphql/graphql-spec/blob/master/README.md) for the [Specification for GraphQL](https://github.com/graphql/graphql-spec). This library is designed to work with the [GraphQL.js](https://github.com/graphql/graphql-js) reference implementation of a GraphQL server. -An overview of the functionality that a Relay-compliant GraphQL server should provide is in the [GraphQL Relay Specification](https://facebook.github.io/relay/docs/en/graphql-server-specification.html) on the [Relay website](https://facebook.github.io/relay/). That overview describes a simple set of examples that exist as [tests](src/__tests__) in this repository. A good way to get started with this repository is to walk through that documentation and the corresponding tests in this library together. +An overview of the functionality that a Relay-compliant GraphQL server should provide is in the [GraphQL Relay Specification](https://relay.dev/docs/guides/graphql-server-specification/) on the [Relay website](https://relay.dev/). That overview describes a simple set of examples that exist as [tests](src/__tests__) in this repository. A good way to get started with this repository is to walk through that documentation and the corresponding tests in this library together. ## Using Relay Library for GraphQL.js @@ -167,7 +167,7 @@ After cloning this repo, ensure dependencies are installed by running: npm install ``` -This library is written in ES6 and uses [Babel](http://babeljs.io/) for ES5 transpilation and [Flow](http://flowtype.org/) for type safety. Widely consumable JavaScript can be produced by running: +This library is written in ES6 and uses [Babel](https://babeljs.io/) for ES5 transpilation and [Flow](https://flow.org/) for type safety. Widely consumable JavaScript can be produced by running: ```sh npm run build @@ -181,19 +181,11 @@ After developing, the full test suite can be evaluated by running: npm test ``` -While actively developing, we recommend running +## Opening a PR -```sh -npm run watch -``` - -in a terminal. This will watch the file system run lint, tests, and type checking automatically whenever you save a js file. - -To lint the JS files and run type interface checks run `npm run lint`. +We actively welcome pull requests. Learn how to [contribute](./.github/CONTRIBUTING.md). -### Opening a PR - -This repository is managed by EasyCLA. Project participants must sign the free ([GraphQL Specification Membership agreement](https://preview-spec-membership.graphql.org) before making a contribution. You only need to do this one time, and it can be signed by [individual contributors](http://individual-spec-membership.graphql.org/) or their [employers](http://corporate-spec-membership.graphql.org/). +This repository is managed by EasyCLA. Project participants must sign the free ([GraphQL Specification Membership agreement](https://preview-spec-membership.graphql.org) before making a contribution. You only need to do this one time, and it can be signed by [individual contributors](https://individual-spec-membership.graphql.org/) or their [employers](https://corporate-spec-membership.graphql.org/). 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. @@ -201,6 +193,10 @@ You can find [detailed information here](https://github.com/graphql/graphql-wg/t If your company benefits from GraphQL and you would like to provide essential financial support for the systems and people that power our community, please also consider membership in the [GraphQL Foundation](https://foundation.graphql.org/join). +## Changelog + +Changes are tracked as [GitHub releases](https://github.com/graphql/graphql-js/releases). + ## License graphql-relay-js is [MIT licensed](./LICENSE). diff --git a/package.json b/package.json index 306dddc..517d06b 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,7 @@ }, "repository": { "type": "git", - "url": "http://github.com/graphql/graphql-relay-js.git" + "url": "https://github.com/graphql/graphql-relay-js.git" }, "main": "index.js", "types": "index.d.ts",