From 4cc0f55a417db21fcd2eb9880e65b00a673a4a15 Mon Sep 17 00:00:00 2001 From: carolstran Date: Wed, 25 Nov 2020 11:51:24 +0100 Subject: [PATCH 1/2] Updating contributing guidelines for Code page --- CONTRIBUTING.md | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c42de3709b..290fd66463 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -79,11 +79,30 @@ If you notice something wrong in the text or code samples, please follow our [de All of the content on graphql.org is written and formatted in [Markdown](https://www.gatsbyjs.com/docs/mdx/markdown-syntax/). -### Add a library or tool to the Code page +### Add a library, tool, or service to the Code page -The [Code page](https://graphql.org/code/) is a collection of libraries, tools, and services built for GraphQL. +The [Code page](https://graphql.org/code/) is a collection of libraries, tools, and services built for GraphQL. -To add your resource to this page, follow our [development guide](#development-guide) to [open a pull request](https://github.com/graphql/graphql.github.io/pulls). +#### General guidelines + +**Adding a resource:** +- With rare exceptions, any pull request that adds a new library, tool, or service to the Code page will be accepted. +- Any library should include a few paragraphs describing the usage and offering people a chance to grok the project priorities. +- If there isn't a section already for your programming language, please add it. + +If it isn't a library, tool, or service - then it could go into the community section. If it doesn't fit in any of these cases, then ping me or Ivan and we can figure out if/where it can live. + +**Removing a resource:** +- Services that don't work anymore +- Code repositories that are archived +- Projects declared to be abandoned by their maintainers +- Any link that 404s + +We rely on these concrete signals before removing a resource. Even if a project hasn't been released in a few years, that doesn't mean that it's not working. + +#### Workflow + +To add or remove a resource to this page, follow our [development guide](#development-guide) to [open a pull request](https://github.com/graphql/graphql.github.io/pulls). The content for this page is located in [various directories under `src/content/code`](./src/). Everything is written and formatted in [Markdown](https://www.gatsbyjs.com/docs/mdx/markdown-syntax/). From ae8f2972b610dc229ae8ba9b19a725f1953aa22b Mon Sep 17 00:00:00 2001 From: carolstran Date: Thu, 26 Nov 2020 04:10:53 +0100 Subject: [PATCH 2/2] Fix mistakes oops --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 290fd66463..f93a75369a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -90,7 +90,7 @@ The [Code page](https://graphql.org/code/) is a collection of libraries, tools, - Any library should include a few paragraphs describing the usage and offering people a chance to grok the project priorities. - If there isn't a section already for your programming language, please add it. -If it isn't a library, tool, or service - then it could go into the community section. If it doesn't fit in any of these cases, then ping me or Ivan and we can figure out if/where it can live. +If it isn't a library, tool, or service - then it could go on the [Community page](#add-a-resource-to-the-community-page). If you aren't sure where your resource would fit, you can [open an issue](https://github.com/graphql/graphql.github.io/issues/new) and ask. **Removing a resource:** - Services that don't work anymore