docs: contributing (#64)

Co-authored-by: Denis Badurina <[email protected]>

Author: spawnia

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# How to contribute to graphql-http
+
+## Contributors license agreement
+
+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/).
+
+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](https://github.com/graphql/graphql-wg/tree/main/membership).
+If you have issues, please email [[email protected]](mailto:[email protected]).
+
+## Adding implementations
+
+[The implementations folder](implementations) contains setup for server implementations that allows checking their compliance with the [GraphQL over HTTP spec](https://graphql.github.io/graphql-over-http).
+
+Every implementation is expected to contain a `package.json` file with at least the following fields:
+
+```json
+{
+  "private": true, // prevents warnings
+  "name": "implementation-name", // should be equivalent to the directory name
+  "url": "https://implementation-name.example", // the official project URL
+  "scripts": {
+    "start": "node ." | "docker-compose up -d" // depending if the server can be run through node or Docker
+  }
+}
+```
+
+Depending on how your server is run, add it to the appropriate section of [.github/workflows/audits.yml](.github/workflows/audits.yml):
+
+- `node .`: `jobs.javascript.strategy.matrix.workspace`
+- `docker-compose up -d`: `jobs.docker.strategy.matrix.workspace`
+
+The script run in `start` is expected to bring up an HTTP server that listens to the port defined in the environment variable `$PORT`.
+
+After adding your directory and `package.json`, run `yarn install` to include the workspace.
+
+## Code formatting
+
+Run the following script to ensure the automatic code formatting is applied:
+
+    yarn run lint:fix

README.md

@@ -774,7 +774,9 @@ Having said this, graphql-http is mostly aimed for library authors and simple se
 
 ## [Servers](/implementations)
 
-If you want a feature-full server with bleeding edge technologies, you're recommended to use one of the following.
+If you want a feature-full server with bleeding edge technologies, you're recommended to use one of the following servers.
+
+Their compliance with the [GraphQL over HTTP spec](https://graphql.github.io/graphql-over-http) is checked automatically and updated regularly.
 
 <!-- <ServersTable> -->
 <!-- prettier-ignore-start -->
@@ -798,16 +800,11 @@ Check the [docs folder](docs/) out for [TypeDoc](https://typedoc.org) generated
 
 ## [Audits](implementations/)
 
-Inspect audits of other implementations in the [implementations folder](implementations/). Adding your implementation is very welcome!
+Inspect audits of other implementations in the [implementations folder](implementations).
+Adding your implementation is very welcome, [see how](CONTRIBUTING.md#adding-implementations)!
 
 ## Want to help?
 
-File a bug, contribute with code, or improve documentation? Read up on our guidelines below and drive development with `yarn test --watch` away!
-
-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/).
-
-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](https://github.com/graphql/graphql-wg/tree/main/membership). If you have issues, please email [[email protected]](mailto:[email protected]).
+File a bug, contribute with code, or improve documentation? [Read more in CONTRIBUTING.md](CONTRIBUTING.md).
 
 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).

package.json

@@ -88,7 +88,8 @@
   "scripts": {
     "gendocs": "typedoc --options typedoc.js src/",
     "lint:eslint": "eslint 'src'",
-    "lint:prettier": "prettier -c .",
+    "lint:prettier": "prettier --check .",
+    "lint:fix": "yarn lint:eslint --fix && yarn lint:prettier --write",
     "lint": "yarn lint:eslint && yarn lint:prettier",
     "type-check": "tsc --noEmit",
     "test": "NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 jest",